Pensieve ·

"I use Pensieve. One simply siphons the excess thoughts from one's mind, pours them into the basin, and examines them at one's leisure. It becomes easier to spot patterns and links, you understand, when they are in this form."

Albus Dumbledore

This project contains the web application for Pensieve providing the interface to create and review items. This project was bootstrapped with Create React App and will be useful to reference its User Guide.

Installing

Clone this project and update path accordingly:

git clone git@github.com:pensieve-srs/pensieve-web.git
cd pensieve-web/

Install the dependencies:

yarn install

Note: if you don't have yarn installed, feel free to use npm.

Copy the .env.example and update the variables to your settings:

cp .env.example .env.development.local

Make sure you have an API server running, either locally or on a server. The API server repository is here: https://github.com/pensieve-srs/pensieve-api. The default server url is localhost:5000 but feel free to modify.

Finally, run the app in development mode:

yarn start

Open http://localhost:3000/ to view it in the browser.

Go to http://localhost:3000/signup to create an account and get started.

Contributing

Roadmap

View the Project Roadmap which includes upcoming features, reported bugs, and other updates to the project.

Contributing Guide

All work happens directly on GitHub and contributions are welcomed!. Submit a Pull Request to introduce new code changes. Open an Issue to request a new feature or report a bug. Interested in contributing? Contact @nlaz for help to get started.

License