Flask React Project

a name="readme-top">

Scrollr

A clone of the popular Tumblr web application. Scrollr is a place to share ideas and opinions with others. You are able to post, comment and even follow other users.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

'A clone of the popular Tumblr web application. Scrollr is a place to share ideas and opinions with others. You are able to post, comment and even follow other users.'

(back to top)

Built With

• React
• JavaScript
• Python
• HTML
• CSS
• Flask

(back to top)

Getting started

1. Clone this repository (only this branch)

2. Install dependencies

   pipenv install -r requirements.txt

3. Create a .env file based on the example with proper settings for your development environment

4. Make sure the SQLite3 database connection URL is in the .env file

5. This starter organizes all tables inside the flask_schema schema, defined by the SCHEMA environment variable. Replace the value for SCHEMA with a unique name, making sure you use the snake_case convention.

6. 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

7. To run the React App in development, checkout the README inside the react-app directory.

(back to top)

Usage

Create your account with secure hashed password protection.

The home page displays the Feed that shows all of the posts others have shared.

You may comment or like a post and even follow another user if you enjoy their content.

With validation in place any errors that you may encounter are intuitively brought to the users attention.

(back to top)

Roadmap

• Followers
• Posts
• Likes
• Comments

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

(back to top)

Contact

Patrick McKinney -  [email protected]
Nathan Heinz -
(James) Xinbo Zhou -
John Timothy Cruz - [email protected]

Project Link: https://github.com/NRH-AA/Python_Project.git

(back to top)

(back to top)