pcrebels/README.md
2020-02-23 11:16:47 -05:00

1.7 KiB

PC Rebels

To do (Add to this and use ~~content~~ to show its done)

  • Add Readme
  • Set Up init files

Set Up:

  1. Download & install: vscode or any editor of your choice
  2. Download & install: nodejs this is needed to host the website
  3. Download & install: git this is so we can use git from the commandline
  4. Once this is done we have to init the local repo
  5. In vscode use Ctrl+~ to open up a terminal and go to a directory where you want the repo to live: type in git clone https://github.com/rayaman/pcrebels.git Note: This creates a folder named after the repo
  6. Next once that is done run npm install This will install all the node modules that we need to run the server
  7. And with that everything should be stable and runnable
  8. You will need to create a file called dev.env inside of the config folder. This is where we put private variables that we dont want being committed. The .gitignore file makes sure that we dont commit this file
  9. Now let's test to see if things worked
    • There are 2 ways to run the code
    • npm start This is how the webhost will run our code
    • npm test This uses nodemon which reloads our code automatically when we make any changes and makes dev work eaiser. (Use npm test when you can)
  10. Once you got the code running go to http://localhost:3000/ and see if something comes up.

Vscode Extensions to make working with nodejs a little eaiser