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
+16-6Lines changed: 16 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@ This platform also makes users introduce and develops various solutions in the f
22
22
23
23
### Frontend Technology Stack
24
24
25
-
-CSS: Styling web pages, html files
25
+
-SCSS: Styling web pages, html files
26
26
- Javascript: Primary programing language
27
-
- ReactJS: Javascript library for building User Interfaces
27
+
- ReactJS v16.12: Javascript library for building User Interfaces
28
28
- Bootstrap: Styling framework.
29
29
30
30
Learn more about the donut platform at the [official donut documentation](https://docs.codeuino.org/donut-social-networking-platform/).
@@ -35,11 +35,11 @@ Learn more about the donut platform at the [official donut documentation](https:
35
35
36
36
Few things are required before setting up the project locally,
37
37
38
-
-**A Web Browser** - You can install any browser as per your preference e.g. Internet Explorer,Chrome, FireFox, Safari, Opera etc. JavaScript works on any web browser on any OS.
38
+
-**A Web Browser** - You can install any browser as per your preference e.g. Google Chrome etc. JavaScript works on any web browser on any OS.
39
39
-**An Editor**- We prefer an editor which has built-in features of IntelliSense support and syntax error highlighter for speedy development. Download Visual Studio Code from [here](https://code.visualstudio.com/download).
40
40
-**Node and Node Package Manager(NPM)**
41
41
Check if node and npm are already installed by running the following commands in the terminal
42
-
`node -v npm -v`
42
+
`node -v npm -v`
43
43
If the node and npm are installed
44
44
If not, install it in,
45
45
-**Windows & MacOS**
@@ -51,7 +51,7 @@ Few things are required before setting up the project locally,
51
51
52
52
-**Ubuntu**
53
53
The easiest way to install the most recent LTS version of Node 10.x is to use the [package manager](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions) to get it from the Ubuntu _binary distributions_ repository. This can be done very simply by running the following two commands on your terminal:
Once the command completes you will have a new folder containing the cloned repository. We can validate this by running the “dir” command. We can then move into that directory using the "cd " command.
83
+
Once the command completes you will have a new folder containing the cloned repository. We can validate this by running the “dir” command. We can then move into that directory using the "cd social-platform-donut-frontend" command.
84
84
85
85

86
86
@@ -113,6 +113,15 @@ npm start
113
113
114
114
Now visit the [http://localhost:3000](http://localhost:3000) using your favorite browser to see your very own donut-frontend app in action!
115
115
116
+
There are few last steps to follow however before you can start exploring the donut platform.
117
+
To get most out of locally setup frotnend environment, we highly suggest to setup an instance of the donut backend as well. The backend repository could be found at [https://github.com/codeuino/social-platform-donut-backend](https://github.com/codeuino/social-platform-donut-backend)
118
+
119
+
1. Once the backend environment is successfully setup, create a new Organization/Community by visiting the link [http://localhost:3000/setup](http://localhost:3000/setup). Follow the instructions and fill in the fields provided by the screen.
120
+
2. The next step is sign up using a new admin account. This could be achieved by visiting the [http://localhost:3000/admin](http://localhost:3000/admin) and using the "Admin Account Signup card."
121
+
3. Login using the newly created admin account.
122
+
123
+
You are now all set to explore the donut platform!
124
+
116
125
# Contributing to the donut frontend.
117
126
118
127
**Choosing an issue**
@@ -172,5 +181,6 @@ Now the changes we have made are pushed into our fork in GitHub. The final step
172
181
173
182
In order to make a pull request, visit the forked repository on github. On the top right hand side a button will now be there mentioning that a pull request is ready to be made.
174
183
184
+
Prior to making the PR make sure to choose the base branch as development branch using the dropdown.
0 commit comments