chrisfishbob / ionic-pen

1 stars 2 forks source link

Ionic Pen

Ionic Pen is a open-souce MERN stack Wattpad alternative. Our main focus is on the reading and writing of fanfiction. We support reading, writing, reviewing, searching, and much more!

API

Note: Run the backend on port 3200 before starting the application. Information of the API can be found here https://github.com/Samay-1305/ionic-pen-api/blob/main/README.md

UI Prototype

https://www.figma.com/file/c8UHVgMAIyej0bX7prE2wl/Ionic-Pen?node-id=1%3A16

Formatter (Prettier) Link

https://prettier.io

Setup Instructions

First clone this repository, then cd ionic-pen execute npm ci in terminal

Running the application

Execute npm start in terminal from the source code directory.

Demo

We have a super short demo on this repo called ionic-demo.mp4. But the best demo is to try it out! https://github.com/chrisfishbob/ionic-pen/blob/main/ionic-demo.mp4

Test Coverage

alt text

Class Diagram

alt text