Skip to main content

Introduction

Britannic is a venue booking system backend that provides simple APIs to help you with managing bookings of venues.

API References#

The Britannic API is built and organized around REST. Our API accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Quickstart Guide#

  1. Clone the reporsitory from here
  2. Install dependencies using npm i command
  3. Set your environment variables in the env file.
  4. Run npm start
  5. The application should be running on localhost:8080 if the port number is not defined in the enviornment variable file

Disclaimer#

This application is still in development. If you have any feedback, feature requests, improvement suggestions, kindly send them over here with the appropriate labels. All feedbacks are welcomed.