diff --git a/README.md b/README.md index 4d42eb52..0258eb99 100644 --- a/README.md +++ b/README.md @@ -31,18 +31,18 @@ There are many showcase/example React projects out there but most of them are wa ## Setting up development environment 🛠 - Install [postgreSQL](https://www.postgresql.org/) if you don't have it already and create a database named `jira_development`. -- `git clone https://github.com/oldboyxx/jira_clone.git` +- `git clone https://github.com/oldboyxx/jira_clone.git`. - Create an empty `.env` file in `/api`, copy `/api/.env.example` contents into it, and fill in your database username and password. -- `npm run install-dependencies` -- `cd api && npm start` -- `cd client && npm start` in another terminal tab -- App should now be running on `http://localhost:8080/` +- `npm run install-dependencies`. +- `cd api && npm start`. +- `cd client && npm start` in another terminal tab. +- App should now be running on `http://localhost:8080/`. ## Running cypress end-to-end tests 🚥 -- Set up development environment -- Create a database named `jira_test` and start the api with `cd api && npm run start:test` -- `cd client && npm run test:cypress` +- Set up development environment. +- Create a database named `jira_test` and start the api with `cd api && npm run start:test`. +- `cd client && npm run test:cypress`. ## What's missing?