You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-45
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
10
10
## Guidelines
11
11
12
12
1. Entry level tutorial
13
-
- What is Temacode
13
+
- What is Teamcode
14
14
- How I can use TemCode
15
15
- Interface Projects
16
16
- Project Collaborators
@@ -27,75 +27,75 @@ This project was generated with [Angular CLI](https://github.com/angular/angular
27
27
28
28
## Entry level tutorial
29
29
### What is TeamCode?
30
-
TeamCode is an onlide coding tool centerd in provide an in-real-time comunication between a team conformed by an Owner, a Writer and Auditors.
30
+
eamCode is an online coding tool centred in provide an in-real-time communication between a team conformed by an Owner, a Writer and Auditors.
31
31
32
-
TeamCode provides you the tools to upload your projects and share or discuss changes while you are live sharing this modifications with you teammates.
32
+
TeamCode provides you with the tools to upload your projects and share or discuss changes while you are live sharing these modifications with your teammates.
33
33
34
34
### How I can use TeamCode?
35
-
TeamCode only have one requeriment to start using it. You need to login using your GitHub account. This requeriment exists for two main reasons:
36
-
- Bring the maximum seccurity to our users relying in GitHub.
35
+
TeamCode only has one requirement to start using it. You need to log in using your GitHub account. This requirement exists for two main reasons:
36
+
- Bring the maximum security to our users relying on GitHub.
37
37
- Provide an integrated GitHub toolbox to interact with some advanced actions introduced in the "Advanced level tutorial".
38
38
39
39
### Interface Section
40
-
Once you log in into TeamCode, your interface will be loaded. This interface consists in three sections:
40
+
Once you login into TeamCode, your interface will be loaded. This interface consists of three sections:
41
41
- Projects
42
42
- Feed
43
43
- Statistics
44
44
45
-
Every section aims to offer you control and traking in your projects. All this while trying to be as minimalist as possible. In this "Entry level tutorial" we will only introduce you the "Projects" section.
45
+
Every section aims to offer you control and tracking in your projects. All this while trying to be as minimalist as possible. In this "Entry level tutorial", we will only introduce you to the "Projects" section.
46
46
47
-
Projects section introduce you intro the control of your projects. TeamCode works with Workspace Objects which will store all your changes, file data and user modifications to provide the best possible teamwork experience.
47
+
Projects section introduce you into the control of your projects. TeamCode works with Workspace Objects which will store all your changes, file data and user modifications to provide the best possible teamwork experience.
48
48
49
49
<palign="center">
50
50
<imgsrc="https://i.imgur.com/rhZGe6R.png?1"/>
51
51
</p>
52
52
53
-
There are 4 possible interactions. Once you enter to TeamCode with a new account you'll only have one possible interaction. This will be the addition button "+". With this you'll be ble to create your firs TeamCode project.
53
+
There are 4 possible interactions. Once you enter to TeamCode with a new account you'll only have one possible interaction. This will be the addition button "+". With this, you'll be able to create your first TeamCode project.
54
54
55
-
Once you will have at least one TeamCode project you'll unlock the other 3 interactions. This ones will be:
55
+
Once you will have at least one TeamCode project you'll unlock the other 3 interactions. These ones will be:
56
56
- Trash icon: Delete the TeamCode project.
57
57
- Play icon: Load the TeamCode project.
58
58
- Pagination buttons: Swap between the different project pages.
59
59
60
60
### Project Collaborators
61
-
Collaborator Object is used in teamCode as the role to give to all your teamates. This role allow them to visit your projet by sending them the URL. At firsst intance, only Collaborators and project Owner are allowed to see the Project and the project changes. Inside project "Options" dropdown you will find all the management tools.
61
+
Collaborator Object is used in TeamCode as the role to give to all your teammates. This role allows them to visit your project by sending them the URL. At first instance, only Collaborators and project Owner are allowed to see the Project and the project changes. Inside project "Options" dropdown you will find all the management tools.
62
62
63
63
<palign="center">
64
64
<imgsrc="https://i.imgur.com/jddkefY.png"/>
65
65
<imgsrc="https://i.imgur.com/d01YcXN.png"/>
66
66
</p>
67
67
68
-
These images allow you to see the Collaborators interactions which will have the Owner and Collaborators roles. Project Owner are the only one allowed to manage collaborators inside "List collaborators" tab. Project Owner is also the only one allowed to add more Collaborators to the project, using the "Add collaborators" tab. When a Collaborator access to "List collaborators" tab, only view options will be available, without any type of control over the rest of the Collaborators.
68
+
These images allow you to see the Collaborators interactions which will have the Owner and Collaborators roles. Project Owner is the only one allowed to manage collaborators inside "List collaborators" tab. Project Owner is also the only one allowed to add more Collaborators to the project, using the "Add collaborators" tab. When Collaborator access to "List collaborators" tab, only view options will be available, without any type of control over the rest of the Collaborators.
69
69
70
70
### User Status
71
-
Inside the project we already know the "Writer" and "Collaborator" roles. Apart of this roles we also have "Writer" and "Auditor". This two roles were previously introduced in [Project Collaborators](###Project-Collaborators) section.
71
+
Inside the project, we already know the "Writer" and "Collaborator" roles. Apart from these roles we also have "Writer" and "Auditor". These two roles were previously introduced in [Project Collaborators](###Project-Collaborators) section.
72
72
73
73
-**Auditor**: Auditor is a role to avoid Collaborators to modify the project content without permission. While you are in Auditor role you'll still be able to:
74
74
- Request at any moment the Writer role by using the "Ask to write" tab.
75
75
- Write in the project files.
76
76
- Your changes will **NOT** be uploaded or shared with the rest of the team.
77
-
- Any change done in a file previously edited by the project Writer will be **OVERWRITEN**.
78
-
- Once you'll ask and receive the Writer role you local changes will be automatically uploaded to the project.
79
-
-**Writer**: There is only one User allowed to have this role. This role allow you to:
80
-
- Make changes to the project or upload you local changes done while you were an Auditor.
77
+
- Any change done in a file previously edited by the project Writer will be **OVERWRITTEN**.
78
+
- Once you'll ask and receive the Writer role your local changes will be automatically uploaded to the project.
79
+
-**Writer**: There is only one User allowed to have this role. This role allows you to:
80
+
- Make changes to the project or upload your local changes done while you were an Auditor.
81
81
- Send the Writer role to any Auditor who requested the role.
82
-
- You can upload files by drag-and-drop them tho the project explorer section.
82
+
- You can upload files by drag-and-drop them to the project explorer section.
83
83
84
84
## Advanced level tutorial
85
85
### TeamCode 💗 Git
86
-
There is a reason why Auditors can still write even if their changes are not uploaded into the TeamCode project. To inctroduce the aim of this feature we need to introduce first the "Secret Folders/Files".
86
+
There is a reason why Auditors can still write even if their changes are not uploaded into the TeamCode project. To introduce the aim of this feature we need to introduce first the "Secret Folders/Files".
87
87
88
88
#### Secret Folders/Files
89
-
TeamCode have an extra feature for the most advanced users. Secret Feature allow you to create files and folder which will **NEVER** be uploaded to the server or shared to the rest of the team by only adding a dot "." before the file or folder name.
89
+
eamCode has an extra feature for the most advanced users. Secret Feature allows you to create files and folder which will **NEVER** be uploaded to the server or shared to the rest of the team by only adding a dot "." before the file or folder name.
90
90
This feature consists of two aims:
91
-
- Provide the users the tools to avoid uploading extra-large files into the server and collapse their user-disk space. While they will still be able to work with this file locally.
92
-
- Provide the users the tools to recreate a Git Structure.
91
+
- Provide the users with the tools to avoid uploading extra-large files into the server and collapse their user-disk space. While they will still be able to work with this file locally.
92
+
- Provide users with the tools to recreate a Git Structure.
93
93
94
94
#### How to recreate Git using Secret Feature?
95
-
This will consist in a few quick steps:
95
+
This will consist of a few quick steps:
96
96
97
97
1. We need to start from the idea of Writer role is the only person to "Commit" and "Push". The rest of the users are only allowed to work locally.
98
-
2. No matter whats your role, you can create a Git branch by using the Secret Feature. Lets imagine the initial projet structure is something like:
98
+
2. No matter what your role, you can create a Git branch by using the Secret Feature. Let's imagine the initial project structure is something like:
99
99
100
100
101
101
(master)
@@ -106,9 +106,9 @@ This will consist in a few quick steps:
106
106
|
107
107
|_ README.md
108
108
109
-
Where "master" is the current project explorer folder. We need to reestructure our projec into a new
110
-
folder with tha name of the branch.
111
-
This branch will be public to let all the teamates see the changes in-real-time.
109
+
Where "master" is the current project explorer folder. We need to restructure our project into a new
110
+
folder with the name of the branch. This branch will be public to let all the teammates see the
111
+
changes inreal-time.
112
112
113
113
114
114
---Writer View---
@@ -123,8 +123,7 @@ This will consist in a few quick steps:
123
123
|_ README.md
124
124
125
125
Now Writer and Auditors are ready to start working on local branches by using the Secret Feature. As
126
-
an Auditor, lets try to create a
127
-
"Develop" branch to work with a SCSS version of the TestComponent.
126
+
an Auditor lets try to create a "Develop" branch to work with an SCSS version of the TestComponent.
128
127
129
128
130
129
---Auditor View---
@@ -146,48 +145,46 @@ This will consist in a few quick steps:
146
145
|
147
146
|_ README.md
148
147
149
-
Now, how a Writer do a "Commit" or a "Push"? He's doing a commit and push into "master" every time he
150
-
modifies a file in the master folder.
151
-
But, how Auditors make commit and push? They need to ask for Writer Role. Once they are the project
152
-
Writer. They will change the files of
153
-
master for their own local versions in the ".develop" folder.
148
+
Now, how a Writer does a "Commit" or a "Push"? He's doing a commit and push into "master" every time he
149
+
modifies a file in the master folder. But, how Auditors make commit and push? They need to ask for
150
+
Writer Role. Once they are the project Writer. They will change the files of master for their own local
151
+
versions in the ".develop" folder.
154
152
155
153
For those that know Git, the system works as we've got some conflicts when we're trying to push our
156
-
changes and now we have to manually solve
157
-
the involved files by adding the new version.
154
+
changes and now we have to manually solve the involved files by adding the new version.
158
155
159
156
160
157
161
158
### Interface Feed
162
-
Interface Feed is still in v0.1 but provides you information of the projects you're subscribbed at. This subscription is automatically done once you're added to a project as a new Collaborator. Can be also done once we create a new TeamCode project. It provides information of:
159
+
Interface Feed is still in v1.0 but provides you information about the projects you're subscribed at. This subscription is automatically done once you're added to a project as a new Collaborator. Can be also done once we create a new TeamCode project. It provides information about:
163
160
- Action done
164
161
- Status after the action was done
165
162
- Workspace involved
166
163
- Date of the action
167
164
- Collaborator added
168
165
169
166
### Interface Statistics
170
-
Interface Statistics provides two charts with information about our projects. First chart provides us information about the size (measured in files) of every project. The second Chart provides you information of what is your most used language.
167
+
Interface Statistics provides two charts with information about our projects. The first chart provides us with information about the size (measured in files) of every project. The second Chart provides you with information about what is your most used language.
171
168
172
169
### IDE Settings
173
170
A setting file was added into StackBlitz project. You can access it by going to:
174
171
175
172
Left Gear Icon "Settings" > Editor Settings > Workspace Settings
176
173
177
-
At this point a ".vscode" folder with a "settings.json" file will be created in your project explorer.
174
+
At this point, a ".vscode" folder with a "settings.json" file will be created in your project explorer.
178
175
179
-
If you want to change any settings, you only have to uncomment the line (Ctrl + K + U) or delete the "/**/" anotation and then change the value.
176
+
If you want to change any settings, you only have to uncomment the line (Ctrl + K + U) or delete the "/**/" annotation and then change the value.
180
177
181
178
### Project Chat
182
-
Project Chat is a feature only available for the project Owner and project Collaborators. This chat provides essential comunication between teammates while they are working.
179
+
Project Chat is a feature only available for the project Owner and project Collaborators. This chat provides essential communication between teammates while they are working.
183
180
184
181
You can access the chat by pressing the "Chat-icon" on the bottom-right corner of your IDE screen.
185
182
186
183
<palign="center">
187
184
<imgsrc="https://i.imgur.com/Z6Da7uS.png"/>
188
185
</p>
189
186
190
-
Once the chat is open you'll be able to see the messages sent by your project collaborators. You will be able to write in the input section. You can also send messages by pressing "Enter" key or pressing "Play button" next to the text input section. Input section let us to resize it if we place the cursor at right-bottom corner of the input box.
187
+
Once the chat is open you'll be able to see the messages sent by your project collaborators. You will be able to write in the input section. You can also send messages by pressing "Enter" key or pressing "Play button" next to the text input section. Input section let us resize it if we place the cursor at the right-bottom corner of the input box.
191
188
192
189
<palign="center">
193
190
<imgsrc="https://i.imgur.com/diNshs1.png?1"/>
@@ -200,7 +197,7 @@ Chat also includes a "silent-mode" to don't disturb users while they are coding.
200
197
</p>
201
198
202
199
### Projects Privacy
203
-
As an extra feature to increase the collaborations in projects, TeamCode provides options to make your project public or private. Each property will modify the visivility of your project.
200
+
As an extra feature to increase the collaborations in projects, TeamCode provides options to make your project public or private. Each property will modify the visibility of your project.
204
201
205
202
- Public projects:
206
203
- Visible for every user (even non-registered users).
@@ -226,13 +223,13 @@ You can change the project privacy at any moment going to "Options > Make projec
226
223
</p>
227
224
228
225
### GitHub Toolbox
229
-
This Feature is only available to the project Writer. The reason is because this feature grants write permissions over the project. We can access the GitHub toolbox by pressing the GitHub button on bottom-right corner of the TeamCode project view.
226
+
This Feature is only available to the project Writer. The reason is that these feature grants write permissions over the project. We can access the GitHub toolbox by pressing the GitHub button on the bottom-right corner of the TeamCode project view.
230
227
231
228
<palign="center">
232
229
<imgsrc="https://i.imgur.com/itbg1FK.png"/>
233
230
</p>
234
231
235
-
The first option allow us to load a Github file by uploading the URL of it. While the second Option allow us to **OVERWRITEN** the actual TeamCode project to load a Web-Framework project by providing the combination of:
232
+
The first option allows us to load a Github file by uploading the URL of it. While the second Option allows us to **OVERWRITE** the actual TeamCode project to load a Web-Framework project by providing the combination of:
0 commit comments