bumi/tinyforms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
bumi 2020-04-06 09:20:39 +00:00 committed by GitHub
parent 58f9420830
commit 524a81ca9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,24 +1,37 @@
# README # Tinyforms
This README would normally document whatever steps are necessary to get the Form endpoint that allows to push data from a static HTML form directly into a google spreadsheet.
application up and running.
Things you may want to cover: ## Installation
* Ruby version ### Requirements
* System dependencies * ruby 2.6 or higher
* PostgreSQL
* Configuration ### Installation
* Database creation Install gem dependencies and setup the database:
* Database initialization ```bash
$ bundle install
$ rails db:setup
```
* How to run the test suite ### Configration
* Services (job queues, cache servers, search engines, etc.) To use the application the Google API client needs to be configured using the following environment variables:
* Deployment instructions * GOOGLE_CLIENT_ID
* GOOGLE_PROJECT_ID
* GOOGLE_CLIENT_SECRET
* ... You can get those from the [Google APIs Dashboard](https://console.developers.google.com/apis/dashboard)
Store those in a `.env` file; see `env.example` for an example.
### Run the application
$ rails server # loads the configruation from the .env file
Open [localhost:3000](http://localhost:3000)