Github-Issues

The project shows the github issues of the Reactjs project. It contains pagination, filtering Open & Closed issues and comments for every issue. It also contains a detailed view by selecting an issue giving more information to the user regarding the issue selected.

You can find the kanban board of this project here.

Teck Stack

The project is build with React and Typescript. It uses jest and testing-library for testing. It also uses Tailwind CSS for styling.

For continuous integration and continuous deployment it uses Netlify CI/CD. The project has been deployed here: https://github-issues-prj.netlify.app/

The project is also using Snyk for security vulnerabilities, and Codacy for code static analysis.

Run it locally

1. Clone the project on your local machine.
   $ git clone https://github.com/basilisSam/Github-Issues.git

2. Navigate to the project folder and install the dependencies with the following command.
   $ npm install

3. Run the application locally (the application can be accessed from localhost:3000)
   $ npm run start

Available scripts

Run app locally

You can run the application locally by using npm run start.

Test

You can run the tests of the application with npm run test

Test with watch

You can run the tests of the application and enable watching for any updates with npm run test:watch

Test with coverage

You can run the tests of the application and generate a coverage report with npm run test:coverage

The report can be found in the /coverage/ folder.

Lint

You can lint the project with npm run lint

Lint with fix

You can lint the project and attempt to fix issues with npm run lint-fix

Build

You can build the application in production mode with npm run build

Build production

You can build the application in production mode, run tests and lint the project with npm run build:prod

Note: You can use yarn instead of npm

CI/CD

The following steps are running when a commit is made to main branch:

1. Triggers a build pipeline
2. Lint code
3. Run tests
4. Build project