EventBookingAPI

Backend for an Event Booking Application build with Node and TypeScript 🚀

---

---

---

This project uses yarn package manager, To install yarn use npm i -g yarn

---

To start the project, clone the repository and install dependecies:

> git clone https://github.com/harryportal/EventBookingAPI
> cd EventBookingAPI
> yarn add

---

Create a .env.test and .env.development and populate using the .env.sample file.

---

If you have docker installed, you can start the postgres database with yarn run start:db

# run migrations on your database
> yarn run db:migrate
# start server
> yarn run dev

To run the Unit and Integration test:

• Create a test database or your use this command if you have docker installed to start the test db yarn run test:db

# run migration
> yarn run test:migrate
# yarn test
> yarn run test

ROADMAP:

• Set up Boiler Plate
• Set up model with Prisma
• Implement Authentication Endpoints and Google Sign In
• Implement Event creation and attendee endpoints
• Implement Mailing with nodemailer and google app
• Set up Cloudinary for storing event images
• Add Documentation with Postman
• Write Unit and Integration Test
• Deploy to Heroku:rocket: