Git Product home page Git Product logo

teapost's Introduction

TEAPOST - Story Publishing Web App

DEMO

Frontend Backend
teapost.vercel.app teapost.herokuapp.com

Features

  • Reader

    • can read news, comment, like or dislike and share news.

    • can add stories/news to Reading collection like YouTube playlist.

    • can follow authors and when following author publish story/news followers would be notified.

  • Author

    • can write stories in collaboration with other authors.

    • can write stories in steps, instance at each step would be saved in history timeline of story where author can reference back like in Github.


Tech Used

  • Stack- MERN
  • Language - TypeScript
  • Front-End - NextJS, Formik, ChakraUI, SWR, Sun-Editor
  • Back-End - Express, Yup(Validation), JWT
  • DBMS - MongoDB
  • Assets Management - Cloudinary
  • Hosting - Heroku, Vercel

How to use

1.) Install Deps

npm run bootup

2.) Set Config (Optional)

To use default config

npm run mvConfig

OR

Set .env vars at

cd app/client/.env
cd app/server/config/.env

3.) Run data seeder

Create minimum essential data to kickstart app

npm run seed:k

OR

Create High Volume Data, This may take time

npm run seed:i

4.) Run dev server

npm run dev

App ready On

Frontend Backend
localhost:3000 localhost:4000

TODOS

  • Testing
  • GraphQL-ise

teapost's People

Contributors

imsamad avatar

Stargazers

AnnMargaret Tutu avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.