Skip to content

Commit 66a9675

Browse files
committed
docs(readme): Improve first step of setting up Ruby + MySQL
1 parent 2737954 commit 66a9675

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,36 +73,42 @@ If there's a new feature you're looking to implement, **please** file an issue t
7373

7474
## Development
7575

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
7777

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
7985

8086
```bash
8187
$ git clone [email protected]:codeRIT/hackathon-manager
8288
$ cd hackathon-manager
8389
```
8490

85-
2. Install dependencies
91+
3. Install dependencies
8692

8793
```bash
8894
$ bundle install
8995
```
9096

91-
3. Setup databse
97+
4. Setup databse
9298

9399
```bash
94100
$ bin/rails db:setup
95101
```
96102

97-
4. Start up the server
103+
5. Start up the server
98104

99105
```bash
100106
$ bin/rails s # short for bin/rails server
101107
```
102108

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
104110

105-
5. In another bash window, promote your user to an admin
111+
7. In another bash window, promote your user to an admin
106112

107113
```bash
108114
$ cd hackathon-manager
@@ -112,7 +118,9 @@ Loading development environment (Rails 5.1.1)
112118
irb(main):001:0> User.last.update_attribute(:role, :admin)
113119
```
114120

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_
116124

117125
### Development Utilities
118126

0 commit comments

Comments
 (0)