The best way to organize events' dates!
About the project | Technologies | Getting started | How to contribute | License
This api provides everything needed to organize events' dates.
Users can use it to save and to manage their events.
To see the DevCalendar web client, click here
Technologies that I am using to develop this api:
- Node.js
- TypeScript
- Express
- Multer
- TypeORM
- JWT-token
- uuid v4
- PostgreSQL
- Date-fns
- Jest
- SuperTest
- Husky
- Commitlint
- Commitizen
- Eslint
- Prettier
- EditorConfig
Import the Insomnia.json
on Insomnia App or click on Run in Insomnia button
- Node.js
- Yarn or npm
- One instance of PostgreSQL
I recommend use docker
Clone the project and access the folder
$ git clone https://github.com/AlexsandroBezerra/devcalendar-server.git && cd devcalendar-server
Follow the steps below
# Install the dependencies
$ yarn
# 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 devcalendar-postgres -e POSTGRES_DB=devcalendar \
-e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres
# Once the service is running, run the migrations
$ yarn typeorm migration:run
# To finish, run the api service
$ yarn dev
# Well done, project is started!
Make a fork of this repository
# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork AlexsandroBezerra/devcalendar-server
Follow the steps below
# Clone your fork
$ git clone your-fork-url && cd devcalendar-server
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new feature'
# Send the code to your remote branch
$ git push origin my-feature
After your pull request is merged, you can delete your branch
This project is licensed under the MIT License - see the LICENSE file for details.
Made with 💜 by Alexsandro G Bezerra 👋 See my Linkedin