A Twitter clone built using Flask, Flask-SocketIO and Peewee ORM. Users are able to post and interact with messages in real-time!

Please ensure that you have Python and Node.js installed on your system. The following instructions were written for macOS/Linux users.

Open a terminal, enter psql, and then the following commands:

CREATE DATABASE chitter;
CREATE DATABASE chitter_test;
\l
\q

1. Open a terminal and navigate to the root folder of the cloned repository.
2. run echo "SECRET_KEY='my_secret_key_value'" | tee .env

1. Open a terminal and navigate to the root folder of the cloned repository.

# 2. create a virtual environment (assuming you have Python 3 installed) by running the following command:
python3 -m venv venv

# 3. activate the virtual environment:
source venv/bin/activate

# 4. install the Python dependencies:
pip install -r requirements.txt

# 4.1 at this point you may want to run the following before continuing:
deactivate
source venv/bin/activate

# 5.1 install the Node.js dependencies using pnpm. If you don't have pnpm installed, you can install it globally by running:
npm install -g pnpm

# 5.2 then, from the root folder of the repository:
pnpm install

# 6. build the Tailwind CSS styles:
pnpm run build:css --watch

# 7. in another terminal tab from the same root folder, start the Flask web server:
python app.py

This should start the server, and you should see output indicating that the app is running locally.

8. Open a web browser and visit http://localhost:5000 to see the app in action.

Be sure to open the app in two different browsers (or with one window in incognito mode) to test out WebSocket. You'll need to create two different user accounts in order to see it in action. Have fun!

As a User
So that I can let people know what I am doing
I want to post a message (peep) on Chitter

As a User
So that I can see what others are saying
I want to see all peeps in reverse chronological order and in real time

As a User
So that I can better appreciate the context of a peep
I want to see the time at which it was made

As a User
So that I can post messages on Chitter as myself
I want to be able to sign up, sign in to, and sign out of, Chitter

YET TO IMPLEMENT

As a User
So that I can stay tapped in to Chitter
I want to receive an email if I am tagged in a Peep