All Projects → colie31 → Memorecall

colie31 / Memorecall

Licence: other
a/A Capstone Project

Programming Languages

python
139335 projects - #7 most used programming language
CSS
56736 projects
javascript
184084 projects - #8 most used programming language
HTML
75241 projects
Dockerfile
14818 projects
Mako
254 projects
shell
77523 projects

Banner

Memorecall

GitHub Pipenv locked Python version GitHub language count GitHub last commit npm

An application that allows a user to create and store personal journals

Table of Contents

Installation

(Back to top)

To use this project, first clone the repo on your device using the command below:

  • Create a git repository git init

  • Clone Memorecall application git clone https://github.com/colie31/Memorecall.git

  • Install dependencies from root directory pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

  • Create a .env file using the following template:

>FLASK_APP=app  
>FLASK_ENV=development  
>SECRET_KEY=((Insert your own secret key here))  
>DATABASE_URL=postgresql://((Admin Username)):((Admin Password))@((Host Address))/((Database Name))
  • Set up a PostgreSQL database user with a username, password and database name that you provided in the .env file.

  • Follow sqeuence to go into the pipenv shell and migrate, then seed the database:

pipenv shell

flask db upgrade

flask seed all

flask run

  • Once you have the database set up and the flask app running, you should be able to install the react app and run it to connect to the backend. On a new terminal, change from the root directory into the ./react-app directory and run the following:

npm install

  • Once dependencies are installed, create a .env file here with the following template:

REACT_APP_BASE_URL=((Host Address, such as http://localhost:5000))

  • You should be able to run the following:

npm start

Usage

(Back to top)

Log in with by clicking Demo Login or Sign Up!

Demo Login

Every User has there own bookcase where they will be able to add/delete/view there journals. Once you have created your own personalized journal, You can start creating entries!!

Creating a journal

Now lets create some entries! Select a journal and view your journal to add entries by clicking add on the journal nav bar. App uses react-modern-calendar-datepicker library, more info @ github link - so you can find your journal entries easier, so make as many as you want!

Memorecall App

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].