Express RESTful API

An attendance application RESTful API was built using Express and TypeScript.

Table of Contents

• Requirements
• Installation
• Screenshoot

---

Requirements

Before setting up the project, make sure your system meets the following requirements:

• Node: 20
• Express: 4
• MySQL: ^5.7
• Redis: 7.4
• ElasticSearch: 8.5

---

Installation

Follow the steps below to set up the project on your local machine.

1. Clone the repository:

   git clone https://github.com/Devajayantha/express-clock.git

2. Navigate into the project directory:

   cd express-clock

3. Install the required dependencies using npm:

   npm install

4. Copy the .env.example file to .env:

   cp .env.example .env

5. Set up the database:

   • Configure your database connection in the .env file.
   • Run migrations to create the necessary tables:

     npx prisma migrate deploy

6. Run the seeder if needed:

   npx prisma db seed

7. Run project on deplopment mode:

   npm run start

Screenshoot

Here’s some screenshoot from my work.

Thank You