IT[M]Optics API

API for ITMO history project.

Table of contents

1. Getting Started
2. Running
   1. Development
   2. Production
3. Linting
4. Contributing
5. Code of Conduct
6. License

Getting Started

You need to create a .env file and configure your database at first, then set up the database and start developing.

# install deps
yarn install

# run in development mode
yarn dev

# check code styles
yarn lint

# check type errors
yarn typecheck

---

Running

Run in development mode:

Runs the application is development mode. Should not be used in production

yarn dev
# or
yarn dev:debug

Run in production mode:

Compiles the application and starts it in production mode

yarn compile
yarn start

Linting

Check code style, types and fix all linter errors

yarn lint
yarn lint:fix
yarn typecheck

---

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/itmo-corp/itmoptics-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the ITMOptics project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

License

The gem is available as open source under the terms of the MIT License. Copyright 2022 itmo-corp