Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 2.87 KB

README.md

File metadata and controls

94 lines (59 loc) · 2.87 KB
Raw

Geckos-Team-26

(A Chingu Voyage-4 remote development team)

The Project

A web app to help pet owners record their pet's progress, keep track of essential information, and provide reminders of important events and milestones.

Meet the team:

Environment Variables

To set up the environment variables..

  • Enter npm run updateall to install the dotenv dependency.
  • Create a file named .env in the root directory and add the following code.
DBURL=PUT THE DB URL HERE
JWTSECRET=PUT THE JWT SECRET HERE
  • Create a file named .env in the /client directory and add the following code.
REACT_APP_oAuthClientSecret=PUT THE OAUTH CLIENT SECRET HERE

Also ensure that the following files match the examples below before commiting to git.

utils/config.js

const dbUrl = process.env.DBURL;
const jwtSecret = process.env.JWTSECRET;

module.exports = {
  dbUrl,
  jwtSecret
};

client/src/googleCredentials.js

const clientId = process.env.REACT_APP_oAuthClientSecret;
export default clientId;

How to start the app

Run the following commands to install dependencies for both the client and server

  • npm run installserver
  • npm run installclient

Run this command to start the dev environment:

  • npm run dev

The dev script begins by running ESLint. If the dev environment fails to start, please check the console for lint errors/warnings.

If you get any errors related to nodemon, then please install it globally by running this command, and try again.

  • npm install -g nodemon

Please run the following command to update any new dependecies:

  • npm run updateall

More Information

How to get create-react-app to work with a Node.js back-end API

Style Guide

ESLint will run automatically each time you run the dev script. Errors and warnings will be displayed in the console. If errors are present, the dev environment will not start. Please resolve the errors and try again.

The following commands can be run in order to lint the code without starting the dev environment:

  • npm run lint:client
  • npm run lint:server

ESLint's formatting rules are disabled. Style formatting is handled by Prettier, using a precommit hook.
Prettier will re-format staged files during the commit process.
It is recommended that you also integrate Prettier into your code editor, so that you can take advantage of Prettier's functionality in real time, as you code.