/fictadvisor-api

Backend application for fictadvisor.com

Primary LanguageTypeScriptMIT LicenseMIT

Logo

API

Backend application for fictadvisor.com
Explore the docs »

View the Website · Report a Bug · Request a Feature

Table of contents
  1. About the project
  2. Getting started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About the project

This application provides a REST API for FICT Advisor.

Built with

Getting started

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

Prerequisites

  • yarn npm i -g yarn

Installation

  1. Clone the repository 
    git clone https://github.com/fictadvisor/fictadvisor-api.git
  2. Install NPM packages 
    yarn install

Usage

To start the application for production:

yarn build
yarn start:prod

To start the application locally:

yarn start:dev

To run tests:

yarn test

Roadmap

See the open issues for a list of proposed features (and known issues). Also you can check out design document for better understanding of architecture and functionality of our back-end service.

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 a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Added an amazing feature')
  4. Push the branch (git push -u origin feature/amazing-feature)
  5. Open a pull request

License

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

Contact

Feedback - https://t.me/fict_robot
Project - https://github.com/fictadvisor

Acknowledgements