xpo-backend

Public api available at: https://xpo.restful-api.site

How to use api you can check from doc/xpo.postman_collection.json

Installing dependencies:

1. Clone this repo git clone <repo_url>
2. Create .env file (touch .env)
3. Generate new secret bundle exec rake secret
4. Create DEVISE_SECRET_KEY variable in .env file with value from previous step
5. Create RAILS_ENV variable in .env with value production or development

Installing dependencies part 2 (non-Docker users):

1. Install postgres
2. Install redis
3. Install dependencies bundle install

Installing dependencies part 2 (Docker users):

1. Check Docker and docker-compose installations
2. Run docker-compose build for building app image

Deployment instructions (non-Docker users):

1. Check if postgres instance is available (start cmd: systemctl start postgres or brew services start postgres)
2. Check if redis instance is available (start cmd: redis-server)
3. Create and setup database: rake db:{create,setup}
4. Start the sidekiq: sidekiq -e $RAILS_ENV

• To start development server: rails server webrick -b 127.0.0.1 -p 3000 -e development
• To start production Puma server: rails server Puma -b 127.0.0.1 -p 3000 -e production

Deployment instructions (Docker users):

1. Up postgres service docker-compose up db redis
2. (Optional, if needed) Run db setup: docker-compose run web rake db:{create,setup}
3. Start the sidekiq: docker-compose up sidekiq
4. To start server: docker-compose up web

---

• To stop server for non-Docker users: CTRL+C
• To stop server for Docker users: docker-compose stop or docker-compose down for stopping and removing all containers/networks/volumes that were created to start the app.