search

ctc-uci / find-your-anchor-backend

MIT License
2 stars 0 forks source link

readme

Find Your Anchor Backend

Setting up development environment

To start working on with this project, follow these steps:

  1. Install the EditorConfig plugin for your IDE.
  2. Add the .env file stored in your projects Google Drive folder to the root of the project.
  3. Install NodeJS and yarn following the instructions here.
  4. Navigate to the project folder in your terminal and run yarn to install required packages.

Project branching structure

Due to complications with some of the GitHub Actions this project uses, the git branch structure is non-standard.

  1. dev: This is the main branch of the project. All PRs should be merged into this branch, as if it was "main".
  2. main: This is the "production-ready" branch of the project; dev should only be merged into main when it is at a presentable state.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode, with hot-reload support from nodemon.\ The server will be accessible from http://localhost:3001, and will reload if you make edits.\ You will also see any lint errors in the console.

yarn format

Formats .js files with Prettier.\ See the Prettier docs for more information.

ESLint and Prettier

This project uses ESLint and Prettier to enforce the Airbnb JavaScript Style Guide.

ESLint Plugins

Currently, the following ESLint plugins are installed:

  1. eslint-plugin-prettier

Visit the links to learn more about each plugin.

Configuration

The configuration for ESLint is inside the .eslintrc.json file, located in the root of the project. Learn more about ESLint here.

The configuration for Prettier is inside the .prettierrc file, located in the root of the project. Learn more about Prettier here.

Husky and lint-staged

This project uses lint-staged and husky to run ESLint checks before all commits.

Skipping pre-commit checks

Use the --no-verify option to skip pre-commit checks, but please note that this is strongly discouraged.

Configuration

The configuration for lint-staged is inside the lint-staged object inside of package.json. Learn more about lint-staged here.

The configuration for husky is in the .husky directory, located in the root of the project. Learn more about husky here.

Learn more about Node and ExpressJS

You can learn about Node here.

To learn about express, check out the this express tutorial here.