This repository contains scripts to facilitate the development and testing process of a project using Docker Compose and npm scripts. Follow the instructions below to set up and run the project.
- Docker installed on your machine (Docker Installation Guide)
- Node.js and npm installed on your machine (Node.js Installation Guide)
- Clone this repository to your local machine.
git clone [email protected]:luuanfaria/clone-tabnews.git
- Navigate to the project directory.
cd clone-tabnews
- Install project dependencies.
npm install
To start the development server and bring up the required services using Docker Compose, run:
npm run dev
This command will start the necessary services defined in the infra/compose.yaml
file using Docker Compose and then start the development server.
To stop the running services, run:
docker-compose stop
To stop and remove the services, run:
docker-compose down
To check the code style using Prettier, run:
npm run lint:check
To automatically fix code style issues using Prettier, run:
npm run lint:fix
To run tests using Jest, run:
npm test
To run tests in watch mode using Jest, run:
npm run test:watch
- Ensure that Docker is installed and running on your machine before starting the development server.
- Make sure to run
docker-compose up
before starting the development server (npm run dev
).
Follow these instructions to get started with the project. If you encounter any issues, refer to the error messages or feel free to reach out for assistance. Happy coding!