Scene-it is a React-Rails app discussion platform based off of Reddit. It is a single page web app, with a Rails back end acting strictly as an API. The app utilizes Redux middleware and RESTful react-router routing to manage state and navigation.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
This project utilizes a PostgreSQL database. You'll need to have PostgreSQL set up locally, but there are plenty of guides out there like this one if you're unfamiliar.
Start off by forking and/or cloning this repo.
Front End:
Navigate to the client directory from the root directory
cd client
Install dependencies
npm install
Start up the front end server
npm start
Back End:
Navigate to the api directory from the root directory
cd api
Install dependencies
bundle install
(Assuming PostgreSQL is properly set up) Create the database
rake db:create
Run migrations
rake db:migrate
Fill database with test users
rake db:seed
Start up the Rails server on port 4000
rails s -p 4000
Now just navigate to localhost:3000 on your web browser and get started! You can experiment with the API via localhost:4000 as well.
There currently aren't any tests for this repo, but the intent is to add some in the near future.
Not ready for deployment in its current state, but stay tuned!
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE file for details
- Everyone at Flatiron School/Learn.co for creating a fantastic curriculum and awesome learning environment.
- uinames.com for great test user data!