Skip to content

fatiudeen/interview-calender

Repository files navigation

Interview Calendar API

📜 Table of Contents

  • Contact

  • ABOUT

    An API/Service developed to manage interview schedules. Contains endpoints for creating interviewers and candidates, check time slots, as well as scheduling the interviews.

    The documentation is accessible via the link below;

    API documentation link

    INSTALLATION

    Option A: Using Docker

    1. Clone this repository and open your terminal/command line app in the root folder

    2. Run the command below to start app container (accessible via localhost:3000)

    docker compose up

    NB: You Access API documentation at localhost:3000/docs

    Option B: Use this option if you want to play around with the code on your local machine

    1. Clone this repository and open your terminal/command line app in the root folder

    2. Install dependencies

    npm install

    1. Run tests using the command below

    npm run test

    1. Run the command below to start server (app will run on default port 3000)

    npm start

    1. Run the command below to start server in developer mode (server will auto restart when changes are made)

    npm run dev


    Technologies Used

    The following are the major tools that have been utilized for developing this service.

    Contact

    📜 END

    About

    No description, website, or topics provided.

    Resources

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published