SpongeBook

Record beautiful life, share with the ones you love.

Getting Started

The following instructions will get you a copy of this project and you can run the project on your local machine.

Prerequisites

You need to install the following software:

• Node - v12.16.1

• npm - 6.13.4

• Python - 3.6.8

Clone

• Clone this repo to your local machine using git clone https://github.com/HumphreyLu6/SpongeBook.git

Structure

.
├── comment                 # Backend app
├── friend                  # Backend app
├── mysite                  # Backend app
├── node                    # Backend app
├── post                    # Backend app
├── public                  # Frontend resource
├── src                     # Frontend source code
├── user                    # Backend app
├── manage.py               # Backend Django entry
├── package.json            # Node package
├── Procfile                # Heroku config
├── requirements.txt        # Python Package
├── runtime.txt             # Python version
├── LICENSE
└── README.md

Setup

Install the package for frontend

$ npm install

Install the package for backend (virtual environment recommened)

$ pip install -r requirements.txt
$ python manage.py migrate

Run

Run frontend

$ npm start

Run backend

$ python manage.py runserver

Run tests

$ npm test
$ python manage.py test

Documentation

• Backend APIs: please reference our documentation Wiki page

Contributors / Licensing

Generally everything is LICENSE'D under the Apache 2 license by Zhonghao Lu.

All text is licensed under the CC-BY-SA 4.0 http://creativecommons.org/licenses/by-sa/4.0/deed.en_US

Contributors:

• Devin Dai

• Isaac Zhang

• Qiaoyan Zhang

• Yuan Wang

• Zhonghao Lu

Demo Video

• YouTube
• bilibili
• Download

Acknowledgments