https://github.com/omarsar/ruby_starter
:large_blue_diamond: :large_blue_diamond: A sinatra + ruby web app for beginners; a ruby + sinatra boilerplate :large_blue_diamond: :large_blue_diamond:
https://github.com/omarsar/ruby_starter
Last synced: 7 months ago
JSON representation
:large_blue_diamond: :large_blue_diamond: A sinatra + ruby web app for beginners; a ruby + sinatra boilerplate :large_blue_diamond: :large_blue_diamond:
- Host: GitHub
- URL: https://github.com/omarsar/ruby_starter
- Owner: omarsar
- Created: 2016-05-24T06:35:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-24T07:56:42.000Z (over 9 years ago)
- Last Synced: 2025-01-23T06:14:50.423Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## :point_right: Sinartra + Ruby Starter Repo
Basically, you clone it and it serves a starter for any ruby sinartra app. I find it useful becuase I am always building simple sinatra apps and I end up setting up the same files repeatedly; in other words, this repo should save you a couple of minutes.
## :point_right: Usage / Short description of project
1. Clone with `git clone https://github.com/omarsar/ruby_starter.git`
2. Add your gems or libraries here `Gemfile`
3. Add your configurations here `/config/config_env.rb
4. Revise your procfile `Procfile`
5. Create your main app here `app.rb`
6. Setup app to run here `config.ru`
7. You can change your helper function here `/helpers/helper.rb`
8. Your app's public assets go here `/public/`
9. Depending of what you are using for templating / layouts, they go here `/views/
10. Finally, run `rackup` in root directory of your app
## :point_right: Additional commands for pushing to Github
1. Remove current remote with this command `git remote remove origin`
1. Start with a clean git repository `git init`
1. Add your files `git add .`
1. Make sure to manage what goes public here `.gitignore`
1. Commit changes of your project `git commit -am "first commit"`
1. Add remote `git remote add origin `
1. Add it is ready to be pushed `git push -u origin master`
1. Change your `README.md` file to a description of your particular project and how other can contribute to it.
## Status
In progress :construction_worker:
## To-do sheet
1. Add more common libraries and setup useful code.
## :point_right: How to Contribute?
* Fork repository
* Submit Pull Request
## :point_right: Contact
For questions please email: :envelope: ellfae@gmail.com