Update readme with basic instructions
This commit is contained in:
34
README.md
34
README.md
@@ -1,24 +1,26 @@
|
|||||||
# README
|
# National Parks Demo App
|
||||||
|
|
||||||
This README would normally document whatever steps are necessary to get the
|
## Prerequisites
|
||||||
application up and running.
|
|
||||||
|
|
||||||
Things you may want to cover:
|
- Ruby 3.4.7
|
||||||
|
- Bundler
|
||||||
|
|
||||||
* Ruby version
|
### Deps
|
||||||
|
|
||||||
* System dependencies
|
- Ruby 3.4.7
|
||||||
|
- Rails 8.0.3
|
||||||
|
- SQLite
|
||||||
|
|
||||||
* Configuration
|
## Getting started
|
||||||
|
|
||||||
* Database creation
|
```
|
||||||
|
bundle install
|
||||||
|
bin/rails db:prepare
|
||||||
|
bin/rails server
|
||||||
|
```
|
||||||
|
|
||||||
* Database initialization
|
## Testing
|
||||||
|
|
||||||
* How to run the test suite
|
```
|
||||||
|
bin/rspec
|
||||||
* Services (job queues, cache servers, search engines, etc.)
|
```
|
||||||
|
|
||||||
* Deployment instructions
|
|
||||||
|
|
||||||
* ...
|
|
||||||
|
|||||||
Reference in New Issue
Block a user