API

GHShop API

This project is powered by Amber Framework.

Installation

  1. Install required dependencies
  2. Run shards install

Usage

To setup your database edit database_url inside config/environments/development.yml file.

To edit your production settings use amber encrypt. See encrypt command guide

To run amber server in a development enviroment:

amber db create migrate
amber watch

To build and run a production release:

  1. Add an environment variable AMBER_ENV with a value of production
  2. Run these commands:
npm run release
amber db create migrate
shards build --production
./bin/gh_shop

Docker Compose

To set up the database and launch the server:

docker-compose up -d

To view the logs:

docker-compose logs -f

Note: The Docker images are compatible with Heroku.

Contributing

  1. Fork it ( https://github.com/GHShop/API/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • c910335 Tatsiujin Chin - creator, maintainer
Owner
github statistic
  • 0
  • 0
  • 0
  • 0
  • over 2 years ago
  • March 26, 2018
License

MIT License

Links
Synced at

Sat, 16 Jan 2021 21:16:43 GMT