fattylee/fattylee-storybook

Storybook

Publish your thought and make a difference!

This is app was created for the brilliant minds to showcase their thoughts for the benefit of humanity.

Open App

Table of Content

Features
Technology
Installation
Testing
API End Points

Features

Below are the features of my Storybook app

Users

Users can Signup on Storybook app
Users can Signup via a third party service such as Facebook/Google
Users can Login on Storybook
Users can Login via a third party service such as Facebook/Google
Users can create an article
Users can Get all articles
Users can Get an article
Users can Update an article
Users can Delete an article
Users can upload a profile picture
Users can upload a cover image for an article
Users can change password
Users can reset password

Technologies and Languages

Modern JavaScript technologies were adopted in this project

ES2015: Also known as ES6 or ECMASCRIPT 6, is a new and widely used version of Javascript that makes it compete healthily with other languages. See here for more infromation.

NodeJS: Node.js is an open-source, cross-platform JavaScript run-time environment which allows you enjoy the features of Javascript off the web browsers and implement server-side web development. Visit here for more information.

ExressJS: This is the web application framework for Node.js Visit here for more information.

MongoDB, Mongoose ORM, PassportJS, Google CLoud Storage (GCS) used for saving images,Sendgrid, Express-handlebars, Webpack, Bootstrap, Less, CSS, HTML5 to mention a few.

Installation

1. Clone this repository into your local computer:

git clone https://github.com/Fattylee/fattylee-storybook.git

2. Navigate into the cloned repository in your computer:

$ cd fattylee-storybook

3. Install dependencies by running.

$ npm install

4. Create a .env file and fill the credencials using the .env.sample file sample at the root directory

5. Start the application by running

$ npm run start:dev

6. Install postman to test all endpoint

Testing

• run test using npm test