Skip to content

Latest commit

 

History

History
81 lines (45 loc) · 2.16 KB

README.md

File metadata and controls

81 lines (45 loc) · 2.16 KB
Raw

pep-it-companies-app

A simple platform for @porqueeuprogramo to improve streams' dynamic!

This platform has a total of 6 pages with an intuitive design for a simple but effective use.

Setup

.env file

  • Go to the api folder and rename the file .env.example to .env
  • Fill all the variables with the correct data to your local project and run the api

How to run the api

cd api

docker compose up -d # to start the dockers containers

npm install # install dependencies

npx prisma migrate dev # migrations to db

npm run start # start the api

How to run locally

cd frontend

npm install # install dependencies

npm run dev # start the frontend

How to make imports

  • Open postman or insomnia

  • Do an HTTP request using GET method to http://localhost:port/migrate

Requests collection

To see the endpoints created I recommend you to install Insomnia and import the file requests.json located inside the api folder, which was previously exported from Insomnia, or check the API readme.

Examples and Structure

Login and Forgot Password page

Composed by a simple form with just the required fields to login or change password from an account.

Screenshots

Companies List page

In the below images we can see the main page of the platform where it's distiguished by the user being authenticated or not. It's simply composed by a table who fills the requirements to identify and give informations about certain company.

Screenshots

Create and Edit Form page

To create or edit the informations about certain company you will resort this pages.

Screenshots