Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 3.19 KB

README.md

File metadata and controls

66 lines (54 loc) · 3.19 KB

Johnson and Jones Family Book

A living archive of familial and ancestral history and stories.

Project Status

This project is still being actively developed.

Tech Stack

  • React
  • Node
  • ExpressJS
  • MongoDB
    Data modeled with MongooseJS
    Client deployed to Surge
    Server deployed to Heroku
    Cloud DB set up with mLab

Usage Instructions

Wanna fork or run it yourself?

Prerequisites

You will need npm, node (and optionally yarn) installed globally on your machine.

Install and Setup

Using npm

  1. Clone down this repository
  2. Run npm install
  3. Start Server with npm run start
  4. Visit App at localhost:3000
  5. Build with npm run build
  6. Deploy /build with any tool or service that supports static sites

Using yarn

  1. Clone down this repository
  2. Run yarn install
  3. Start Server with yarn start
  4. Visit App at localhost:3000
  5. Build with yarn build (generates a static site in the /build folder in the project root)
  6. Deploy /build with any tool or service that supports static sites

Feature Ideas

  • Add images
  • Form data verification
  • "Scroll through history" idea
  • Multiple views (scroll plus family tree or something)
  • User model and login functionality
  • User authorizations for add, update and delete methods