The best way to connect with Peruíbe !
PeruibeTec is an application for the city of Peruíbe in the state of São Paulo, Brazil. It aims to make the city more technological and integrated, in PeruibeTec you really connect with Peruíbe, whether you are a resident or a tourist
Tourists enjoy a usability specifically prepared for tourists
While the residents stay on top of everything that is happening in Peruíbe
The main technologies used in this API are:
- Node.js
- TypeScript
- Express
- Multer
- TypeORM
- JWT-token
- uuid-v4
- PostgreSQL
- Date-fns
- Jest
- SuperTest
- ESlint
- Prettier
- EditorConfig
- Node.js
- Yarn or NPM
- One instance of PostgreSQL
Fyi.: I recommend using the docker
Clone the project and access the folder
$ git clone https://github.com/PeruibeTec/Server && cd ServerFollow the steps below
# Install the dependencies
$ yarn install
# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
$ cp .env.example .env
# Create the instance of PostgreSQL using docker
$ docker run --name peruibeTec-postgres -e POSTGRES_USER=docker \
-e POSTGRES_DB=peruibeTec -e POSTGRES_PASSWORD=docker \
-p 5432:5432 -d postgres
# Once the services are running, run the migrations
$ yarn typeorm migration:run
# Finally, run the api service in a development environment :)
$ yarn dev:server
# Well done, project is started!Thank you for being interested in making this package better. We encourage everyone to help improve this project with new features, bug fixes or performance improvements. Take some time to read our contribution guide to make this process faster and easier.
To understand how to submit an issue, commit and create pull requests, check our Contribution Guidelines.
This project is licensed under the GPL 3.0 License - see the LICENSE file for details.