Skip to content

Commit

Permalink
Update set-up notes (#111)
Browse files Browse the repository at this point in the history
* Update set-up notes

* Apply formatting changes

---------

Co-authored-by: mai-vu <[email protected]>
  • Loading branch information
mai-vu and mai-vu authored May 28, 2024
1 parent 0f77933 commit 811d3a3
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,17 @@ Name: job-bank
## Installation

To install the project, clone the repository and run `npm install` to install all dependencies:
**Notes:** This is a React + Next.js project. Please follow these steps to run the project.

- git clone https://github.com/your-username/job-bank.git
- cd job-bank
- npm install
- Clone the repository (git clone https://github.com/your-username/job-bank.git). Navigate to root folder (cd job-bank)
- Add the ‘ .env.local’ file to the project.
- Run ‘npm install’ or ‘npm i’ to install dependencies/packages
- Run ‘npm run dev’ to see changes in the local development environment
- To apply EsLint and Prettier before committing, run > npm install or > npm i.
- Make sure to follow the linting rules defined in .eslintrc and .prettierrc.
- Environment variables are loaded using dotenv.
- Run ‘npm run build’ before merging to main to ensure there are no build errors before deployment
- Git commits trigger linting and formatting checks before being committed due to Husky and lint-staged configurations.

**Scripts:**

Expand Down Expand Up @@ -117,14 +124,6 @@ To install the project, clone the repository and run `npm install` to install al
- `ts-jest`: TypeScript preprocessor with source map support for Jest.
- `typescript`: TypeScript language.

**Notes:**

- Use [npm run dev] to start the development server.
- To apply EsLint and Prettier before committing, make sure to run > npm install or > npm i.
- Make sure to follow the linting rules defined in .eslintrc and .prettierrc.
- Environment variables are loaded using dotenv.
- Git commits trigger linting and formatting checks before being committed due to Husky and lint-staged configurations.

**DevOps Notes**

- In the main.yaml, the Docker Image is currently being uploaded to a personal Docker Hub repo (Account name is cassidyboilley099 and repo is job-bank)
Expand Down

0 comments on commit 811d3a3

Please sign in to comment.