https://github.com/gemmen29/hello-rails-back-end
https://github.com/gemmen29/hello-rails-back-end
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gemmen29/hello-rails-back-end
- Owner: gemmen29
- Created: 2022-05-03T19:32:35.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-05-04T04:20:36.000Z (about 3 years ago)
- Last Synced: 2025-02-04T13:29:25.716Z (4 months ago)
- Language: Ruby
- Size: 34.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 project that provide random greeting message.
# Front-End Repo
[Link](https://github.com/gemmen29/hello-react-front-end)
## Built With
- Ruby
- Ruby on Rails
- OOP
- SQL Postgres
- CORS
## Getting Started
To get a local copy up and running follow these simple example steps.
- Click on the top right green "code" button.
- On the dropdown menu, choose "download with zip" button.
- After download, extract the zip file and you have the project on your machine.
- Make sure that your PostgreSQL server is running and you have the ability to establish connection with the database.
- Create a new file called `local_env.yml` in the folder `config/` and paste the following code in it:
> `PG_USERNAME: "YourPostgresUsername"`
`PG_PASSWORD: "YourPostgresPassword"`
`GMAIL_USERNAME: "YourGmailSenderUsername"`
`GMAIL_PASS: "YourGmailSenderPassword"`
> Note:
You can use your own gmail account to send emails but first you have to configure 2-Step Authorization and after that you have to configure
> an APP Password for this specific application. If you want more information about this, GOOGLE IT.
- Execute `rails db:create` to create the database.
- Execute `rails db:seed` to put the five different messages in greeting table.
- Run `rails s` to run the application on port `3000`.
## Tests
- If you want to run some unit tests, all you need to do is:
- On your terminal execute:
> `gem install rspec`
- Run the `rspec` command in this case over the path of `spec/`, the resulting command will look like this:
> `rspec spec/`
- If you want to run the tests over the entire project, you can execute the following command:
> `rspec`
## Author
👤 **George Magdy**
- GitHub: [@George_Magdy](https://github.com/gemmen29)
- Twitter: [@George_Magdy](https://twitter.com/georgtriple1)
- LinkedIn: [@George_Magdy](https://www.linkedin.com/in/george-magdy-840/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.