Skip to content

Commit

Permalink
Update README.rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
c-brooks authored Nov 5, 2016
1 parent 1ca833b commit f164f97
Showing 1 changed file with 6 additions and 27 deletions.
33 changes: 6 additions & 27 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,9 @@
== SPORTSELLO
= SPORTSELLO

Sportsello is a social platform to connect sports fans with sports bars and other venues.
== About
Originally created as a Lighthouse Labs final project, it is written using Rails as an API and Vue.js as a frontend.
All of the Vue code is currently in the <tt>app/assets/javascripts/home.js.erb</tt> file, with plans to slowly refactor the code into single-file components to comply with Vue best practices. There are also plans to migrate the backend from Rails onto Node.js.

To set up the app on your machine, please create a .env file following the .env.example
and set up your own PostgreSQL database

Things we may want to cover:

* Ruby version

* System dependencies

* Configuration

* Database creation

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...


Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.
== Setup
To set up the app on your machine, please create a .env file following the .env.example and set up your own PostgreSQL database. Make sure to run all relevant bundler, npm, and browserify commands.

0 comments on commit f164f97

Please sign in to comment.