Add instructions to start server in readme

This commit is contained in:
cheyao 2025-05-13 21:49:31 +02:00
parent c04b4161cb
commit 9c076da8e0
No known key found for this signature in database

View file

@ -1,24 +1,23 @@
# README
# Highway
This README would normally document whatever steps are necessary to get the
application up and running.
Welcome to the Hack Club Highways.
Things you may want to cover:
## Local development
* Ruby version
To run this project, you need to first install `ruby`, `ruby-stdlib`, `postgresql-libs` and `gem`.
* System dependencies
Then, add the following to your `.zshrc` or `.bashrc` to activate the ruby development environment:
```zsh
export GEM_HOME="$(gem env user_gemhome 2>/dev/null)"
export PATH="$PATH:$GEM_HOME/bin"
```
* Configuration
Restart your terminal session, and run the following code at the root of the cloned respository to install the required packages:
```zsh
gem install rails
gem install kamal
bundle install --gemfile /home/cyao/Developer/highway/Gemfile
```
* Database creation
At last, run the executable at `./bin/dev` to start up the development server.
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...