Skip to content

Commit

Permalink
Merge pull request #4 from DFE-Digital/feature/121/update-readme
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
jebw authored May 12, 2020
2 parents d2e6ff1 + 2674dd4 commit d429977
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### JIRA ticket number

### Context

### Changes proposed in this pull request
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# DFE-Digital Get Into Teaching Registrations
# DFE-Digital Get Teacher Training Adviser Service

## Prerequisites

- Ruby 2.7.1
- PostgreSQL
- Ruby 2.6.6
- NodeJS 12.16.x
- Yarn 1.12.x

## Setting up the app in development

1. Run `bundle install` to install the gem dependencies
2. Run `yarn` to install node dependencies
3. Run `bin/rails db:setup` to set up the database development and test schemas, and seed with test data
4. Run `bundle exec rails server` to launch the app on http://localhost:3000
5. (optional) Run `./bin/webpack-dev-server` in a separate shell for faster compilation of assets

Expand All @@ -21,6 +19,9 @@
- [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend)
- RSpec
- Dotenv (managing environment variables)
- Dockerfile
- CI based on GitHub Actions
- Deployment utilising GovUK PAAS

## Running specs, linter(without auto correct) and annotate models and serializers
```
Expand Down

0 comments on commit d429977

Please sign in to comment.