ananthkamath / snote

A simple web app

Snote

Snote is a simple web app to take notes, built using Ruby on Rails.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them:

• Docker

Setup

1. Clone the repository

git clone [e-mail]:ananthkamath/snote.git && cd snote

2. Build the project

docker-compose build

3. Copy the env files

cp .env.example .env.development.local

4. Start the app

docker-compose up

5. Run the migrations

docker exec -it snote-app-1 bundle exec rake db:migrate

To Access The App On Local

Snote

To Run The Tests

You can run all the specs using the following command:

docker exec -it snote_app_1 rspec .

If you want to run a single spec, use the following pattern:

docker exec -it snote_app_1 rspec spec/controllers/notes_controller_spec.rb

To Access The Logs

You can check the development logs using the following command:

docker exec -it snote_app_1 tail -f log/development.log

Built Using

• Ruby on Rails - The web framework used to build the app
• Docker - Used to containerize the app
• MySQL - The database used to store the data

License

This project is licensed under the MIT License - see the LICENSE.md file for details