Skip to content

andrewkeithly/postr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Postr

travis license

Postr is a full stack reddit-style site that uses Node.js, React, and NoSQL databases originally forked from Deniz Basegmez's Asperitas.

To Do

  • Fork, Update Deps, & Squash bugs
  • Re-setup to my preferred best practices
  • Setup Deployment
    • Deploy Server to Cloud (Which one though? 🤔)
    • Deploy client to GitHub sub-directory page

Prerequisites

  • node
  • yarn (and/or npm)
  • mongodb
    $ brew tap mongodb/brew
    $ brew install mongodb-community
    • Otherwise checkout instructions here.

Quick start

  1. Clone this repository

  2. Install server dependencies

    $ cd server
    $ yarn
  3. Install client dependencies

    $ cd client
    $ yarn

Run the app

  1. Start mongodb locally
    $ brew services start mongodb-community
    • Otherwise (Windows installations may already be running a mongo db service read more here.)
    $ mongod --dbpath="path/to/data/db"
  2. Start the server
    $ cd server
    $ yarn start
  3. Start the client
    $ cd client
    $ yarn start
  4. Browse to http://localhost:3000/

Testing

Server

Make sure mongodb is running before testing the server.

$ cd server
$ yarn test

Client

$ cd client
$ yarn test

File Structure

postr

├── .vscode
│	└── launch.json
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .travis.yml
├── LICENSE.md
├── now.json
├── README.md
├── client
│	├── public
│	├── package.json
│	├── yarn.lock
│	├── src
│	│	├── actions
│	│	├── components
│	│	├── config
│	│	├── middleware
│	│	├── reducers
│	│	├── tests
│	│	└── util
│	├── categories.js
│	├── globalStyle.js
│	├── index.js
│	├── serviceWorker.js
│	├── setupTests.js
│	├── store.js
│	├── style.css
│	└── theme.js
└── server
	├── auth
	├── controllers
	├── models
	├── src
	├── test
	├── app.js
	├── config.js
	├── index.js
	├── package.json
	├── routes.js
	└── yarn.lock

Reporting Issues:

License

This project is made available under the MIT License.

About

A simple reddit clone

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.5%
  • HTML 1.2%
  • CSS 0.3%