Welcome to Intent!

Intent is a web application inspired by Brainscape, but with a twist. The intent of Intent is to allow learners to effectively learn steps in a sequence, procedure, or task.

Click here to view Intent

Please see below links to the Project Wiki:

This project is built with:

Directions for Features

Splash Page:

Here you can view the splash page for Intent, visit the my Github and LinkedIn profiles, as well as log in or sign up for Intent.

Log In:

If you have an account, you can enter your credentials and press Login. You can also login as a Demo user by clicking the "Sign in as Demo user" button.

Sign Up:

You can sign up for Intent by clicking the Get Started button

Landing Page:

Once you log in, you are directed to the landing page that displays a navigation bar with your categories as well as an overview of the website.

View, Edit, or Delete a Category:

You can click on a category listed on the navigation bar to view details about the category, as well as topics associated with the category. You can also Edit or Delete the category by clicking the associated buttons.

Create a Category:

You can create a category by clicking on the Create Category button in the navigation bar. This will open a form that allows you to create a category.

View All Topics:

You can view all of the topics associated with a Category by clicking on topics.

View, Edit, or Delete One Topic:

When you click on a topic, you can click on buttons to edit or delete the topic, as well as view, create, edit, and delete steps associated with the topic.

View Steps

While in the topic page, you can view a carousel of the steps associated with the topic. The Summary and Description fields are greyed out until the user clicks on them to reveal the answer.

Create, Edit, or Delete Steps

While in the topic page, you can click on edit steps to create, edit or delete steps for this topic.

Local Installation

To run this application locally, you will need Python and NPM. This root folder contains a backend (app) and frontend (react-app) directory.

Step 1: Download

Clone the project repository in your terminal

git clone https://github.com/coucode/intent.git

Step 2: Backend Setup

Inside of the root directory, run the following command in the terminal to set up the necessary Python dependencies for running the backend server and database.
```
pipenv install -r requirements.txt
```
Create a .env file based on the example with proper settings for your development environment
Make sure the SQLite3 database connection URL is in the .env file
Get into your pipenv, migrate your database, seed your database, and run your Flask app
```
pipenv shell
```
```
flask db upgrade
```
```
flask seed all
```
```
flask run
```

Step 3: Frontend Setup

Navigate to the /react-app directory, run the following command to set up the necessary Node.js dependencies and then start the server.

npm install
npm start

coucode / intent