Skip to content

RusPosevkin/readable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readable

It's a content and comment web app. Users are able to post content to predefined categories, comment on their posts and other users' posts, and vote on posts and comments. Users are also able to edit and delete posts and comments.

How to start

  1. Clone this repository
$> git clone https://github.com/RusPosevkin/readable.git
  1. Install dependencies
$> cd ./readable
$> yarn
  1. Start backend server
$> node server
  1. Start server
$> yarn start
  1. Open a browser and visit http://localhost:3000/

Data

There are three types of objects stored on the server:

  • Categories
  • Posts
  • Comments

Start Developing

To get started developing right away:

  • Install and start the API server
    • cd api-server
    • npm install
    • node server
  • In another terminal window, use Create React App to scaffold out the front-end
    • create-react-app frontend
    • cd frontend
    • npm start

API Server

Information about the API server and how to use it can be found in its README file.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published