Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kdlamini/hello-rails-back-end
https://github.com/kdlamini/hello-rails-back-end
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kdlamini/hello-rails-back-end
- Owner: KDlamini
- Created: 2022-04-13T10:21:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-04-15T18:07:36.000Z (over 2 years ago)
- Last Synced: 2023-03-08T17:08:19.087Z (almost 2 years ago)
- Language: Ruby
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hello-rails-back-end
An api with Greetings for welcome page.
## API Live Preview
[API Docs](https://hello-rails-backendapi.herokuapp.com/api-docs/index.html)
[Greetings JSON](https://hello-rails-backendapi.herokuapp.com/api/v1/greetings)
## React App
[hello-rails-front-end](https://github.com/KDlamini/hello-rails-front-end)
## Built With
- Ruby version 3.1.1
- RoR version 7
## Getting Started
The base URL is: https://hello-rails-backendapi.herokuapp.com
API docs endpoint:
```
/api-docs
```
Show all greetings endpoint:
```
/api/v1/greetings
```
Show a single greeting endpoint:
```
/api/v1/greetings/:id
```
If you prefer to clone the project locally, you can also get to the docs by navigating to http://`domain`:`port`/api-docs. Where `domain` is the domain of your server and `port` is the port of your server.
For example, if your server is running on port 3000, you can navigate to http://localhost:3000/api-docs.
There you will see a list of all endpoints and their descriptions.
## Database creation
Create a Postgres user:
```
$ su - postgres
```
After that access Postgres:
```
psql
```
Then create a user (or a “role”, as Postgres calls it):
```
CREATE ROLE hello_api WITH CREATEDB LOGIN PASSWORD 'hello';
```
Initialize the database:
```
$ rails db:create db:migrate db:seed
```
## Authors
👤 **Simo Nkosi**
- GitHub: [@KDlamini](https://github.com/KDlamini)
- Twitter: [@RealSimoNkosi](https://twitter.com/RealSimoNkosi)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/simo-nkosi-418523180/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/KDlamini/hello-rails-back-end/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- This project is part Final Group Capstone in the Microverse study program.
- Thanks to the Microverse team for the great curriculum.
- Thanks to Code Reviewers for the insightful feedback.
- A great thanks to My coding partners, morning session team, and standup team Partners for their contributions.
## 📝 License
This project is [MIT](./MIT.md) licensed.