kimchirice / codesydney

Code.Sydney

A volunteer coder community based in Sydney, Australia

Setup

1. Install NVM or NVM-Windows.

   • NVM-Windows nvm install latest
   • NVM manual

2. Set node version:

   • If NVM - nvm use
   • If NVM-Windows - nvm use [insert version of latest - can be found with 'nvm list']

3. Install Vue:

   • Install the Vue CLI.
   • Recommended Install Vue Devtools.

4. Install VS Code. Setup VS Code extensions:

   • Vetur
   • ESLint
   • Prettier

5. Open one terminal, navigate to the client directory cd client in your terminal and run:

npm install
npm run serve

1. Open another terminal, cd client, and run json-server --watch membersDb.json
2. Open your browser and navigate to localhost:8080/.

Git setup:

1. Install git.
2. Open your terminal and enter... - git config --global user.name "Your name here" - git config --global user.email "[e-mail]
   Replace the quotation sections with your name and email address respectively, without the quotes. Ensure that the email address is the same as your Github account.
3. Navigate to your desired workspace in the terminal.
4. Enter git clone https://github.com/codesydney/codesydney.git.
5. Navigate to the root folder cd codesydney/.

Git workflow:

Reference: git - the simple guide

1. Create a new branch for the issue you are working on.
2. Make changes to you code.
3. Add the changes to the Index and commit the changes.
   • Ensure you include a descriptive, yet concise, description of the changes.
   • Repeat until your issue is finished.
4. Push to the Github repository git push origin "my_branch_name".
   • Becareful not to push to master.
5. Open Github in your browser and submit a new pull request.

Project Staging URL hosted in Netlify:

Project Staging URL