Skip to content

Latest commit

 

History

History
66 lines (35 loc) · 2.74 KB

README.md

File metadata and controls

66 lines (35 loc) · 2.74 KB
Raw

painting-app-frontend

README

Draw It Out

Goal:

The goal of our application is to allow Users the ability to create personal canvasses and associated a topic with it. Everyone has a subjective interpretation of defined moods or emotions, and this app gives them the creative freedom to draw out how they are feeling. Create a log or journal entry of drawings that you may revisit, or simply use this application as a standalone canvas. The choice is yours!

Symbols throughout the README:

1. "" ==> What is displayed in the application terminal

2. '' ==> What to type into the terminal (excluding the '')

Prerequisites and installation guide to get started (HOSTED BACKEND):

1. Please have the latest version of React JS and an environment such Visual Studio.

2. Fork and clone down a copy of this repository into your local machine.

3. Ensure that all packages have been installed and updated correctly. This will be done for you by running 'npm install' or 'yarn install' in the terminal.

4. If servers are up and hosted, run 'npm start' once to start the application.

5. From there, you may follow the prompts of creating an account (first time users).

Prerequisites and installation guide to get started (UNHOSTED BACKEND):

1. Please have the latest version of React JS and an environment such Visual Studio.

2. Fork and clone down a copy of this repository into your local machine.

3. Ensure that all packages have been installed and updated correctly. This will be done for you by running 'npm install' or 'yarn install' in the terminal.

4. Fork and clone down the backend API server from https://github.com/racross1/painting-app-backend

5. cd into the backend, and type in 'rails s' within the terminal. 

6. Ensuring the backend is up and running, cd into the front end. 

7. run 'npm start' within the terminal of the frontend to start the application.

As a user of our application, a user can do a few things:

1. Create a profile and account. (account is neccessary to view paintings and accessing all features of the application).

2. View galleries of other users.

3. create your own paintings and having access to your personal gallery.

4. Update or delete your account. 

5. Sorting by moods or topics in gallery or personal gallery.

Packages used in the development of the frontend application:

1. Painterro @ https://github.com/devforth/painterro

2. Bootstrap @ https://react-bootstrap.github.io/

3. React Router DOM @ https://reactrouter.com/web/guides/quick-start

Packages used in the development of the backend application:

1. JWT @ https://jwt.io/

2. Rails API Serializer @ https://github.com/rails-api/active_model_serializers