Andela Team Project (Team Cypher) - User API

Table of Contents

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

About The Project

Built With

• Node.js, TypeScript, Express, Postgres, Sequelize ORM

Live Demo

Live Demo Link

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Node.js JavaScript package manager; we’ll use pnpm An IDE or text editor of your choice, we'll Visual Studio Code

Installation

1. Clone the repo

   git clone https://github.com/davis-shyaka/cypher-project-1.git

2. You can use npm, but we recommend pnpm 🔅.

   pnpm install

3. Create a (.env) file and add the following keys:

    PORT=
    DB_NAME=
    DB_USER=
    DB_HOST=
    DB_DRIVER=
    DB_PASSWORD=

4. Start your local development server

pnpm dev

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 MIT License.

Contact

Forgot to add them.

Project Link: Project

Acknowledgements

• The Andela Team
• The Open Source for the help