https://github.com/cvilla714/restful-rails-api
https://github.com/cvilla714/restful-rails-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cvilla714/restful-rails-api
- Owner: cvilla714
- Created: 2021-06-19T23:04:08.000Z (almost 4 years ago)
- Default Branch: development
- Last Pushed: 2021-06-27T08:25:13.000Z (almost 4 years ago)
- Last Synced: 2025-01-16T03:27:19.111Z (5 months ago)
- Language: Ruby
- Size: 53.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RESTful JSON API with Rails
> This project was about creating a RESTfull API in rails
Additional description about the project and its features.
## Built With
- Ruby
- Ruby on Rails
- PostgreSQL
## Live Demo
[Live Demo Link]()
## Getting Started
To get a local copy up and running follow these simple example steps.
- First thing is to clone the repo by clicking on the green button that says "code" on the top right corner
- and in your command line please run this commands
- ` git clone [email protected]:cvilla714/restful-rails-api.git`
- then run `cd restful-rails-api/`
- this will get you in the directory where the app is.
- Please follow the setup and install sections to get the app working
### Prerequisites
- Ruby:3.0.1
- Rails: 6.1.3
- PostgreSQL: 12.5
### Install
- Please run `bundle install` to install of the gems that are needed for the app to work
### Setup the database
- Please run ` rails db:create`
- then run `rails db:migrate`
- and finally run `rails db:seed`
### Usage
- In order to start the app , please run in your command line `rails server`. This will start the server
- Next step is to open a window in your webbrowser and type the addres you were given in the console this will get you to the home page and allow you to use the app
### Run tests
- To run the test please type `rpsec --format documentation`
### Deployment
> In order to deploy this app to Heroku follow the steps below
- First you need to install the Heroku CLI (stands for Command Line) by following [this link](https://devcenter.heroku.com/articles/heroku-cli)
- After successfully installing the Heroku CLI you need to run this command ` heroku create`
- Verify your heroku git remote was created by running `git remote`. You should see `heroku` as one of your remotes.
- Run `git push heroku master`. This will deploy the master branch of your git repository to Heroku.
- If you get a successfull message after Heroku finishing deploying, you're goog to go! you can open your brower with `heroku open`
- If you probably get a notice error. Is because you need to create the database and tables on Heroku's server you can do that by typing
- ` heroku run rails db:migrate`
- `heroku run rails db:seed`
## Authors
👤 **Cosmel Villalobos**
- Github: [@cvilla714](https://github.com/cvilla714)
- Twitter: [@kckeyti](https://twitter.com/kckeyti)
- LinkedIn: [Cosmel Villalobos](https://www.linkedin.com/in/cosvilla/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page]().
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
-
## 📝 License
This project is [MIT]() licensed.