soph-em / makers-chitter Goto Github PK

As a Maker So that I can let people know what I am doing I want to post a message (peep) to chitter

As a maker So that I can see what others are saying I want to see all peeps in reverse chronological order

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

As a Maker So that I can post messages on Chitter as me I want to sign up for Chitter

As a Maker So that only I can post messages on Chitter as me I want to log in to Chitter

As a Maker So that I can avoid others posting messages on Chitter as me I want to log out of Chitter

(back to top)

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

This is an example of how to list things you need to use the software and how to install them.

• pip (Ensure it is installed or upgrade if needed.)

  python -m ensurepip --upgrade

1. Clone the repo

   git clone [email protected]:soph-em/makers-chitter.git

2. Create a Database

• Ensure you have PostgreSQL installed.
• Create a database using the following command:

createdb chitter

3. Initialise the Database

• Navigate to the project directory
• Run the following command to seed the database:

  psql -h 127.0.0.1 chitter < chitter.sql

4. Pipenv install

   pipenv install

5. Activate the virtual environment

   pipenv shell

6. Start the local server

   python app.py

7. Access the App Go to http://localhost:5000 in your web browser to use the app

(back to top)

When logged out, users can see a list of 'Peeps', most recent first.

When logged in, users can write their own 'Peeps' that anybody can then view.

(back to top)

• MVP fitting user stories
• Improve styling
• Add functionality to 'tag' other users in tweets
• Add functionality to go to user profiles

(back to top)