LaymanDocs

Overview

This application is an attempt to make reading or parsing through different types of languages and/or frameworks documentation easier

Demo | Blog

Features

1. User can submit a post
2. User can upvote/downvote a post
3. User can upvote/downvote an elaboration
4. User can create elaborations on another users post

Technologies Implemented

1. Vanilla JS
2. Rails
3. Postgres
4. JWT Authentication

Installation

Backend/API

1. git clone git@github.com:greedybrain/layman-docs-project.git
2. cd into projects backend directory layman-docs-api
3. Run bundle install to install all of LaymanDoc's dependencies
4. Confirm that Postgres is installed on your machine. If not, get it here
5. Create the database by running rails db:create
6. Create migrations by running rails db:migrate
7. If applicable, run rails db:seed to generate any seed data
8. Lastly, run rails s or rails server to generate a live server

Frontend/Client

1. cd into front end directory frontend_client
2. Run open index.html or npm start to run the app in a browser