alexandrelam / epsor

Technical test for Epsor 🚀

Epsor

Technical test for epsor
Report Bug · Request Feature

About The Project

Table of Contents

1. • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

Built With

• Express.js
• Apollo GraphQL
• GraphQL.js
• TypeGraphQL.js
• MongoDB.js

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/alexandrelam/epsor

2. Install NPM packages for commitlint, eslint and prettier

   npm install

3. Run docker container

   docker-compose up

(back to top)

Roadmap

• Handle duplicate Book schema

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alexandre LAM - [e-mail]

Project Link: https://github.com/alexandrelam/epsor

(back to top)