https://github.com/anjacodes/hello-rails-back-end
https://github.com/anjacodes/hello-rails-back-end
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/anjacodes/hello-rails-back-end
- Owner: Anjacodes
- Created: 2022-05-03T15:33:00.000Z (about 4 years ago)
- Default Branch: dev
- Last Pushed: 2022-05-03T20:48:18.000Z (about 4 years ago)
- Last Synced: 2023-03-06T01:03:24.649Z (over 3 years ago)
- Language: Ruby
- Size: 119 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 (API)
This Rails App serves as the backend API for the [Hello-React-Rails-App](https://github.com/Anjacodes/hello-react-front-end)
## 🪛 Built with
* Ruby on Rails
* React
* Redux
Installing Rails
Before you install Rails, you should check to make sure that your system has the proper prerequisites installed. These include:
Ruby
SQLite3
Node.js
Yarn
Installing Ruby
Open up a command line prompt. On macOS open Terminal.app; on Windows choose "Run" from your Start menu and type cmd.exe. Any commands prefaced with a dollar sign $ should be run in the command line. Verify that you have a current version of Ruby installed:
`$ ruby --version
ruby 2.7.0`
Rails requires Ruby version 2.7.0 or later. It is preferred to use latest Ruby version. If the version number returned is less than that number (such as 2.3.7, or 1.8.7), you'll need to install a fresh copy of Ruby.
To install Rails on Windows, you'll first need to install [Ruby Installer](https://rubyinstaller.org/).
Installing SQLite3
You will also need an installation of the SQLite3 database.
Verify that it is correctly installed and in your load PATH:
`$ sqlite3 --version`
The program should report its version.
Installing Node.js and Yarn
Finally, you'll need Node.js and Yarn installed to manage your application's JavaScript.
Find the installation instructions at the [Node.js website](https://nodejs.org/en/download/) and verify it's installed correctly with the following command:
`$ node --version`
The version of your Node.js runtime should be printed out. Make sure it's greater than 8.16.0.
To install Yarn, follow the installation instructions at the [Yarn website](https://classic.yarnpkg.com/en/docs/install).
Running this command should print out Yarn version:
`$ yarn --version`
If it says something like "1.22.0", Yarn has been installed correctly.
Installing Rails
To install Rails, use the gem install command provided by RubyGems:
`$ gem install rails`
Accessing the API from your browser
To open the API in your browser, simply run the following command in your terminal:
`$ rails s -p 4000`
Then, open https://localhost:4000/v1/greetings in your browser to view the API data.
## ✏️ Authors
👤 **Anja**
- GitHub: [@Anjacodes](https://github.com/Anjacodes)
- Twitter: [@Anja_Schmidt7](https://twitter.com/Anja_Schmidt7)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/anja-schmidt7/)
## 🤝 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!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.