@@ -73,36 +73,42 @@ If there's a new feature you're looking to implement, **please** file an issue t
73
73
74
74
## Development
75
75
76
- Pre-requisite: Have a functioning, local Ruby + MySQL development environment. [ See this guide for pointers. ] ( https://gorails.com/setup )
76
+ 1 . Setup Ruby + MySQL for local development
77
77
78
- 1 . Clone the repo
78
+ If you don't already have Ruby + MySQL set up, see [ this guide by GoRails] ( https://gorails.com/setup ) for pointers.
79
+
80
+ * Select your computer's operating system & version
81
+ * If given the choice, use ` rbenv ` -- this will ensure a clean, sustainable Ruby dev environment
82
+ * SQLite and PostgreSQL steps are optional
83
+
84
+ 2 . Clone the repo
79
85
80
86
``` bash
81
87
$ git clone
[email protected] :codeRIT/hackathon-manager
82
88
$ cd hackathon-manager
83
89
```
84
90
85
- 2 . Install dependencies
91
+ 3 . Install dependencies
86
92
87
93
``` bash
88
94
$ bundle install
89
95
```
90
96
91
- 3 . Setup databse
97
+ 4 . Setup databse
92
98
93
99
``` bash
94
100
$ bin/rails db:setup
95
101
```
96
102
97
- 4 . Start up the server
103
+ 5 . Start up the server
98
104
99
105
``` bash
100
106
$ bin/rails s # short for bin/rails server
101
107
```
102
108
103
- 4 . Visit http://localhost:3000/apply , create an account, and complete an application
109
+ 6 . Visit http://localhost:3000/apply , create an account, and complete an application
104
110
105
- 5 . In another bash window, promote your user to an admin
111
+ 7 . In another bash window, promote your user to an admin
106
112
107
113
``` bash
108
114
$ cd hackathon-manager
@@ -112,7 +118,9 @@ Loading development environment (Rails 5.1.1)
112
118
irb(main):001:0> User.last.update_attribute(:role, :admin)
113
119
```
114
120
115
- 6 . Visit http://localhost:3000/manage and set up the hackathon as needed
121
+ 8 . Visit http://localhost:3000/manage and set up the hackathon as needed
122
+
123
+ _ See https://coderit.org/hackathon-manager/ for docs on regular hackathon setup_
116
124
117
125
### Development Utilities
118
126
0 commit comments