You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30Lines changed: 30 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,36 @@ The specifications and the guide to the project can be found on the ['Getting St
39
39
- Paperclip - Facilitated image upload to articles from local env
40
40
- Imagemagick - Formatting of images for upload to blog
41
41
42
+
## 🔑 Setup & Usage
43
+
If you want to poke around or modify this web app, you'll have to first follow a couple of steps to ensure everything runs right.
44
+
### System Requirements
45
+
First off, you'll need the following:
46
+
- Ruby
47
+
- Ruby on Rails
48
+
If you're not sure what either of those is or need pointing in the right direction [this right here](https://www.ruby-lang.org/en/documentation/installation/), is the best place to head.
49
+
50
+
### Usage
51
+
1. After you have this repository downloaded and you've made sure Ruby and Ruby on Rails are updated and on your machine `cd` into this repository, wherever it is you downloaded it to. [Not sure what 'cd' means?](https://www.git-tower.com/learn/git/ebook/en/command-line/appendix/command-line-101)
52
+
2. Once you've `cd` into this repo, type in the command `bundle install`. This will download all the required Ruby Gems for the web app so it can function properly. [Not sure what Ruby Gems Are?](https://guides.rubygems.org/)
53
+
3. Once the `bundle` install command above has finished downloading, ensure you are in this repository's root directory and enter the command `rails server` into your terminal. This will start the Ruby on Rails server, allowing you to now access it from your browser of choice.
54
+
4. Type in `http://localhost:3000/` into your browser address bar and hit enter. You should now see the Rails Blog App!
55
+
5. To access the different pages available, enter the following:
56
+
- localhost:3000/articles
57
+
- localhost:3000/authors
58
+
- localhost:3000/tags
59
+
6. Please be aware that some of these pages do not have full functionality unless you are logged in. To test this, please use the following `email: admin@example.com password: admin`.
60
+
61
+
## � Contributions, Issues and Forking
62
+
63
+
If you have any issues setting up the project or you come across any unintended bugs or problems, please do submit an issue to the [Rails Blogger Issue Page](https://github.com/Rhelli/Rails-Blogger/issues)
64
+
65
+
If you want to make your own changes, modifications or improvements, go ahead and Fork it!
66
+
1. Fork it (https://github.com/Rhelli/Rails-Blogger/fork)
67
+
2. Create your working branch (git checkout -b [choose-a-name])
68
+
3. Commit your changes (git commit -am 'what this commit will fix/add/improve')
69
+
4. Push to the branch (git push origin [chosen-name])
0 commit comments