Skip to content

davidauza-engineer/portrait_api

Repository files navigation

davidauza-engineer Heroku

Portrait API

This project was created as a coding challenge for Portrait.

Built With

  • Ruby on Rails 6.0.4.7.
  • CircleCI.
  • Heroku.

Live Demo

Live Demo Link

Getting Started

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

Prerequisites

Setup

  1. Clone the repository by using git clone [email protected]:davidauza-engineer/portrait_api.git.

Install

  1. Move to the root directory of the project by using cd (path of the project).
  2. Run bundle install to install the required dependencies.
  3. Run bundle exec rails db:create to create the databases needed.
  4. Run bundle exec rails db:migrate to migrate the databases.

Usage

  1. To run the rails server run bundl exec rails s --port 3001.

We'll be using the port 3001 so we can correctly connect with the Portrait Client.

Run tests

  1. To run the tests simply run bundle exec rspec.

Deployment

The application is currently deployed on Heroku. Contact me if you want to deploy an specific version.

Author

👤 David Auza

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Thanks to the Portrait team for allowing me to participate in this challenge.