search

Now-Loading / ChainLetter

a small story writing app
0 stars 2 forks source link

Update Setup Instructions #13

Closed KevinW90 closed 3 years ago

KevinW90 commented 3 years ago

The setup steps are as follows:

  1. Fork the repo to your own account
  2. Clone the forked repo to your machine git clone https://github.com/<YourGitHubUsername>/ChainLetter.git dev-chain-letter
  3. Change directories into the project cd dev-chain-letter
  4. Make sure VSC is open with the project code .
  5. Set up the project to pull updates git remote add upstream https://github.com/Now-Loading/ChainLetter.git
    1. To pull updates git pull upstream develop
  6. Install the node_modules npm i
  7. Create a .env.development file and copy/paste the contents from here
  8. Install the firebase CLI npm install -g firebase-tools

-----DOWNLOAD JDK-----

  1. Download the Java Development Kit (JDK) from here
    1. Scroll down to choose your operating system and the installer version

-----ADD JDK TO PATH-----

  1. Open your system environments by searching the start menu for environments and choosing the option Edit the System Environment Variables
  2. Click on the Environment Variables button at the bottom
  3. Under System variables click Path and then Edit button.
  4. Click the New button and paste C:\WINDOWS\system32;C:\WINDOWS\system32;"C:\Program Files\Java\jdk-<full version number>\bin"

-----FROM VSC TERMINAL-----

  1. Change into the firebase directory cd ./firebase
  2. Start the firebase emulators firebase emulators:start
  3. Open a new terminal +
  4. Start the application npm run start

For Windows users, you might get an error with something like 'Your system does not allow you to run that script.' If you get this error, follow these steps:

  1. Run PowerShell as an administrator
  2. Change external script behavior Set-ExecutionPolicy RemoteSigned
  3. Type y and hit enter
  4. Close PowerShell Window