/novel-tracker-api

Rails backend for novel progress tracking app.

Primary LanguageRuby

Novel Tracker App (back end)

Ever wanted to run your own novel writing contest, or just keep track of your novel writing progress?

This is the Rails API for Novel Tracker, a single page React app where users can create a novel project for a novel writing contest and view others' novel projects.

Dependencies

This API was built with PostgreSQL, so you will need to have it installed on your computer to create the databases needed to run it. I found this article particularly helpful in that regard.

Installation

  1. Fork the repository
  2. Clone the files to your computer
  3. Navigate to /novel-tracker-api in your terminal
  4. Create a .env file, and include this in it:
POSTGRES_USER='your_postgres_username'
POSTGRES_PASSWORD='your_postgres_password'
POSTGRES_HOST='localhost'
POSTGRES_DB='novel_tracker_db'
POSTGRES_TEST_DB='novel_tracker_test_db'
POSTGRES_DEVELOPMENT_DB='novel_tracker_development_db'
GMAIL_ACCOUNT='yournewgmailaccount@gmail.com'
GMAIL_PASSWORD='yourgmailapppassword'
FRONT_END_URL='http://localhost:3001'
RESET_PASSWORD='http://localhost:3001/reset_password'
  1. Run bundle install
  2. Run rails db:migrate
  3. Run rails db:seed. This step is very important as it loads badgetypes into the app!
  4. Run rails s to start the server. Make sure to run the React app at the same time as well!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT