CASLounge API

Backend service responsible for CASLounge via Web API's.

Demo available · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Backend service that handles database queries and authentication for CASLounge applications

Built With

This system was built with the following technologies:

• Prisma
• PostgreSQL
• Supabase (PostgreSQL DB Hosting)
• NodeJS

Getting Started

Hey there! You might be new to nodejs, just follow the instructions below and you'll running the project in no time! ✨

Prerequisites

Let's start with the prerequisites, make sure you have the following installed in your local machine:

• nodejs

  # To check if its installed
  node -v

• yarn

  npm install yarn@latest -g

Installation

• Clone the repository

   # Clone the repo
   git clone https://github.com/CASLounge/elvis.git
   cd ./caslounge/elvis

• Download PostgreSQL client with pgAdmin 4 here

• Install dependencies and database migration

  # Dependencies
  yarn install
  
  # Migration
  # note: dev is for local development only!
  yarn prisma migrate dev

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the - license. See LICENSE for more information.

Contact

Sean Christian Lozana - @devzana - lozanascbusiness@gmail.com

Project Link: CASLounge