https://github.com/larissaperinoto/customer-manager-application

Customer Manager is a Full Stack application to manage clients.
https://github.com/larissaperinoto/customer-manager-application

context-api eslint html javascript joi jwt material-ui mongodb mongoose nodejs prettier react-router reactjs swagger

Last synced: 22 days ago
JSON representation

Customer Manager is a Full Stack application to manage clients.

• Host: GitHub
• URL: https://github.com/larissaperinoto/customer-manager-application
• Owner: larissaperinoto
• Created: 2023-02-21T14:13:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T17:11:48.000Z (almost 2 years ago)
• Last Synced: 2024-11-13T03:14:55.175Z (3 months ago)
• Topics: context-api, eslint, html, javascript, joi, jwt, material-ui, mongodb, mongoose, nodejs, prettier, react-router, reactjs, swagger
• Language: TypeScript
• Homepage:
• Size: 836 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Customer Manager Application

## Description

Customer Manager is a application to manage clients and allows to organize a business service sector, for example.

The application have some functionalities:

- User login verification

- Register new users

- Access customers from the database

- Update customers information

- Register new customers

- Delete customers

## Technologies and Tools



   

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    






This project was developed using the following tools and technologies:

### Front-end

- HTML

- CSS

- [ReactJS](https://pt-br.reactjs.org/)

- [React router](https://reactrouter.com/en/main)

- [TypeScript](https://www.typescriptlang.org/)

- [Material ui](https://mui.com/)

### Back-end

- [Express](https://expressjs.com/pt-br/)

- [TypeScript](https://www.typescriptlang.org/)

- [Docker](https://www.docker.com/)

- [Mongoose](https://mongoosejs.com/)

- [MongoDB](https://www.mongodb.com/)

- [JWT](https://jwt.io/)

- Arquitetura Model-Service-Controller

### Tests

- [Mocha](https://mochajs.org/)

- [Sinon](https://sinonjs.org/)

- [Chai](https://www.chaijs.com/)

### Code alignment

- [ESlint](https://eslint.org/)

- [Prettier](https://prettier.io/)

### Documentation

- [Swagger](https://swagger.io/)

### External APIs

- [Random User Generator](https://randomuser.me/)

## ⚙️ How to run

To run this application start cloning this repository using the following command.

    git clone [email protected]:larissaperinoto/customer-manager-application.git

Navigate to the root folder of the project.

    cd customer-manager-application/

Install the project dependencies using the following command sequence.

    cd backend && npm install

    cd ..

    cd frontend && npm install

    cd ..

In the root of the project, upload the containers of **customer_manager_frontend**, **customer_manager_backend** and **customer_manager_db** with the following command.

    docker-compose up -d

Acess the containers logs:

  - frontend: `docker logs --details customer_manager_frontend`

  - backend: `docker logs --details customer_manager_backend`

  - banco de dados `docker logs --details customer_manager_db`

## How to login

Go to `localhost:3000` in your browser and click on `Register` to create an account. After creating an account, go to the `Login` page and login to the application using the registered username and password.

## API documentation

To access the API documentation, go to `localhost:3001/docs` in your browser after following the project execution steps as described in the "How to run" topic.

Documentation preview

![Captura de tela de 2023-02-21 13-54-41](https://user-images.githubusercontent.com/98956659/220409913-e9a2232b-2f3d-4ab7-b310-4bcca8ec8e42.png)

---

Developed by [Larissa Perinoto](https://larissaperinoto.com.br/), © 2023.