Skip to content
Snippets Groups Projects
Commit 43d90020 authored by Sardar, Shaiban M (UG - Computer Science)'s avatar Sardar, Shaiban M (UG - Computer Science)
Browse files

changed readme content

parent 96816172
No related branches found
No related tags found
1 merge request!37changed readme content
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
# First time cloning on gitlab.surrey.ac.uk # First time cloning on gitlab.surrey.ac.uk
1. Generate your own SSH keys: 1. Generate your own SSH keys:
`ssh-keygen -t ed25519` `ssh-keygen -t ed25519`
2. Add your SSH key to Gitlab (for MacOS): `tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy` 2. Add your SSH key to Gitlab (for MacOS): `tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy`
3. Go to Gitlab, On the top bar, in the top right corner, select your avatar, On the left sidebar, select SSH Keys. In the Key box, paste the contents of your public key. 3. Go to Gitlab, On the top bar, in the top right corner, select your avatar, On the left sidebar, select SSH Keys. In the Key box, paste the contents of your public key.
...@@ -17,9 +17,22 @@ Alternatively, visit this [link](https://docs.gitlab.com/ee/ssh/) for clearer in ...@@ -17,9 +17,22 @@ Alternatively, visit this [link](https://docs.gitlab.com/ee/ssh/) for clearer in
3. Go to the front-end directory with `cd ../front-end` 3. Go to the front-end directory with `cd ../front-end`
4. Run `npm install` 4. Run `npm install`
5. Run the front-end with `npm start` 5. Run the front-end with `npm start`
6. Open two new terminals 6. Open two new terminals
7. For the first terminal go into the authentication dir with `cd server/authentication` and run `npm install` then `npm start` 7. For the first terminal go into the authentication dir with `cd server/authentication` and run `npm install` then `npm start`
8. For the second terminal go into the posts dir with `cd server/posts` and run `npm install` then `npm start` 8. For the second terminal go into the posts dir with `cd server/posts` and run `npm install` then `npm start`
# How to run docker components
To run run the docker components, run `docker-compose up`.
# How to run the app locally
1. To run the app locally, navigate to the `front-end` directory,
run `npm install` then run `npm start`.
2. On a new terminal, navigate to `server/authentication` and run
run `npm install` then run `npm start`.
3. On a new terminal, navigate to `server/societies` and run
run `npm install` then run `npm start`.
4. On a new terminal, navigate to `server/posts` and run
run `npm install` then run `npm start`.
5. Then navigate to http://localhost:3000
...@@ -68,17 +68,3 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/d ...@@ -68,17 +68,3 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/d
### `npm run build` fails to minify ### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
# How to run docker components
To run run the docker components, run `docker-compose up`.
# How to run the app locally
1. To run the app locally, navigate to the `front-end` directory,
run `npm install` then run `npm start`.
2. On a new terminal, navigate to `server/authentication` and run
run `npm install` then run `npm start`.
3. On a new terminal, navigate to `server/societies` and run
run `npm install` then run `npm start`.
4. On a new terminal, navigate to `server/posts` and run
run `npm install` then run `npm start`.
5. Then navigate to http://localhost:3000
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment