Skip to content

IMperiumX/Tweet-It

Repository files navigation

logo

Tweet-It

People on Tweet it knows it first!

contributors last update forks stars open issues license


📔 Table of Contents

(back to top)

🌟 About Tweet-It

People on Tweet it knows it first!

📷 Screenshots

screenshot

👾 Tech Stack

Client
Server
Database
DevOps

(back to top)

🧰 Getting Started

  • A social network app that allows users 🙉 to make posts, follow other users, and “like” 💓 posts.

  • Signed-in users are able to create a new text-based post by typing into a text box and then clicking a button to submit it .

  • The “All Posts” link in the navigation bar send the user to a page where they may see all of the posts from all users, in chronological order.

  • In profile detail page you can see the user's total number of followers as well as the number of individuals he or she follows and a user As a matter of course can't follow onself.

  • The “Following” link in the navigation bar should send the user to a page where they can see all of the posts made by the individuals they are following.

  • Users are able to edit any of their own postings by clicking a "Edit" button or link.

Settings

Moved to settings.

‼️ Prerequisites

  • Create a Virtual environment

    python3 -m venv .venv

  • Activate the Virtual environment

    source .venv/bin/activate

  • Install required packages

    pip3 install -r requirements.txt

  • Run Migration for Models

    python3 manage.py migrate --settings=mysite.settings.local

  • Start Development Server

    python3 manage.py runserver --settings=mysite.settings.local

Basic Commands

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a message that your account cerates succesfully.

  • To create an superuser account, use this command:

    $ python manage.py createsuperuser
    

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

(back to top)

Type checks

Running type checks with mypy:

  mypy Tweet-It

🧪 Running Tests

To run tests, run the following command

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

  coverage run -m pytest\
  coverage html\
  open htmlcov/index.html\

Running tests with pytest

  pytest

🏃 Run Locally

Clone the project

  git clone https://github.com/yusufadell/tweet-it.git

Go to the project directory

  cd Tweet-It

Install dependencies

  pip install -r requirements/local.txt

Start the server

  python mananage.py migrate\
  python manage.py runserver

(back to top)

🧭 Roadmap

  • Todo 1
  • Todo 2

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.

See contributing.md for ways to get started.

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)

📜 Code of Conduct

Please read the Code of Conduct

❔ FAQ

  • Question 1

    • Answer 1
  • Question 2

    • Answer 2

(back to top)

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

Your Name - @WHYUSUF_ - yusufadell.dev@gmail.com

Project Link: https://github.com/yusufadell/tweet-it

💎 Acknowledgements

Use this section to mention useful resources and libraries that you have used in your projects.

(back to top)