Skip to content

Application to control points of companies, admin version.

Notifications You must be signed in to change notification settings

Lissone/point-control-admin-web

Repository files navigation

Point Control - Admin Website

Description   |    Demonstration   |    Requirements   |    Technologies   |    Usage   |    Contributors


License Repo size Top lang Stars repo Forks repo Pull requests Last commit

Report bug · Request feature


Description

This project is the website admin version of a company point control application. The company's accredited employees have access to the data of the rest of the other employees, being able to validate their absences, control and verify the frequency of the beat of entry and exit points and keep the data of all employees in a safe way.

Project developed as an activity of my bachelor's degree in information systems, with the main objective of having a very descriptive and extensive documentation, for anyone to understand the features and learn from it. The api framework was built on clean architecture and documented with Swagger.

To facilitate the development of the project and better describe everything that was created, a flowchart of some of the project's features and relevant information at the time of its development was designed, using Whimsical.

To access the other projects integrated to this one, access:

This project was done in partnership with:

Demonstration

2022-10-10.15-45-34.mp4

Requirements

Technologies

  • ReactJs
  • NextJs
  • Typescript
  • Chakra UI
  • React Hook Form
  • Eslint
    • Airbnb-config with another pessoal rules
    • Import helpers plugin
  • Prettier
  • Commitlint
    • Commitizen

Usage

You can clone it on your pc using the command:

git clone https://github.com/Lissone/point-control-admin-web.git
cd point-control-admin-web

Need to add environment variables:

# .\.env.local

# DEFAULT
BASE_URL_API=http://localhost:5000/api/v1

Install dependencies using:

yarn
#or
npm install

If you have Docker, and want to run the container, use the command:

# Build the project container
docker-compose build
# Up container
docker-compose up

Run application:

yarn dev
#or
npm run dev

Contributors

Thanks goes to these wonderful people, who were part of the project from start to finish:

Moises Morais photo
Moises Morais
Stenio Rapchan photo
Stenio Rapchan
Vinicius Almeida photo
Vinicius Almeida

License

Distributed under the MIT License. See LICENSE for more information.