This repository provides the source code for an API that facilitates the organization and reservation of incubators. It's built using JavaScript, the Express library for web framework functionality, and Prisma for interacting with a database.
For detailed documentation on API endpoints, usage, and examples, please refer to the following link: API Documentation Link
- Incubator Management:
- Create, read, update, and delete incubators.
- Define incubator properties such as model, capacity, and availability.
- Reservation Management:
- Create, read, update, and delete reservations.
- Associate reservations with specific incubators and time slots.
- Manage user access and permissions for reservation creation and modification. (Implementation details depend on your chosen user authentication approach)
- Additional Features (Optional):
- Implement user authentication and authorization to control access to different API functionalities.
- Add functionalities for managing waitlists, notifications, and reminders.
- Node.js and npm (or yarn) installed on your system. You can download them from https://nodejs.org/.
- A database server compatible with Prisma. Refer to the Prisma documentation for supported databases: https://www.prisma.io/docs/concepts/database-providers
-
Clone this repository:
git clone https://github.com/Life-Nest/backend-service.git life_nest_backend
-
Navigate to the project directory:
cd life_nest_backend
- Install dependencies:
npm install
- Create a .env file in the project root directory.
- Use the variables defined in the
.env.example
file as a template to create your .env file.
- Run Prisma migrations to create the database schema:
npx prisma migrate dev
- (Optional) Seed the database with initial data (e.g., sample incubators) using Prisma migrations or a separate script.
- Start the development server:
npm start
This project is licensed under the MIT License.