Fixed README

Author: akhil-gautam

Gemfile

@@ -39,7 +39,6 @@ end
 group :development do
   gem 'annotate', '~> 3.2'
   gem 'letter_opener', '~> 1.8'
-  gem 'reek', '~> 6.1.0', require: false
   gem 'rubocop-github'
   gem 'rubocop-performance', require: false
   gem 'rubocop-rails', require: false

Gemfile.lock

@@ -127,7 +127,6 @@ GEM
     io-wait (0.2.1)
     jb (0.8.0)
     jwt (2.3.0)
-    kwalify (0.7.2)
     launchy (2.5.0)
       addressable (~> 2.7)
     letter_opener (1.8.0)
@@ -221,10 +220,6 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    reek (6.1.0)
-      kwalify (~> 0.7.0)
-      parser (~> 3.1.0)
-      rainbow (>= 2.0, < 4.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rubocop (1.26.0)
@@ -303,7 +298,6 @@ DEPENDENCIES
   pundit
   rack-cors
   rails (~> 7.0.2, >= 7.0.2.3)
-  reek (~> 6.1.0)
   rubocop-github
   rubocop-performance
   rubocop-rails

README.md

@@ -1,24 +1,62 @@
-# README
+## Next.js + Ruby on Rails API
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Next.js on Rails is an optionated template for quickly setting up a project with Next.js as the frontend and Ruby on Rails as the backend API.
 
-Things you may want to cover:
+It follows the best practices of [Next.js](https://nextjs.org/docs/getting-started/introduction) and [Ruby on Rails](https://rubyonrails.org/). It is actively maintained and is a great starting point for new projects.
 
-* Ruby version
+We have added Docker support to this template. You can find the Dockerfile in the `docker` directory. <br><br>
 
-* System dependencies
+*For a quick start, you can run the following command:*
 
-* Configuration
+```bash
+docker-compse up
+```
 
-* Database creation
+## Features:
+#### Backend
+- User Authentication using JWT
+- User Authorization using Pundit
+- Interactor Pattern for API using interactor gem
+- premailer-rails for styling emails with stylesheets
+- pagy for faster pagination
+- jb for a fast JSON API builder
+- MiniTest for testing
+- SimpleCov for code coverage
 
-* Database initialization
+### Frontend
+- User Signup and Login
+- User Profile
+- All basic components under `components/shared`
 
-* How to run the test suite
 
-* Services (job queues, cache servers, search engines, etc.)
+## Setup instructions
 
-* Deployment instructions
+### Manual
+- Ruby 3.0.3
+- Node >= 14.x.x
 
-* ...
+```bash
+# run in the root directory
+$ bundle install
+
+# create database, migrate & seed
+$ rails db:prepare
+
+# install packages and come back to root directory
+$ cd frontend && npm install && cd ..
+
+# run the application using Foreman
+# services are defined in the Procfile
+$ foreman start
+```
+
+### Docker
+```bash
+$ docker-compose up
+```
+
+
+## Contribution
+Contribution is welcome! It can be as simple as fixing a typo.
+<br><br>
+If you're facing any difficulty, create issues in the github repo and I will be happy to help.

entrypoint.sh

@@ -8,5 +8,5 @@ if [ -e tmp/pids/server.pid ]; then
   rm tmp/pids/server.pid
 fi
 
-# Then exec the container's main process (what's set as CMD in the Dockerfile).
+# exec the container's main process (what's set as CMD in the Dockerfile).
 exec "$@"