Welcome to Tech-Tweet, a Django-based microblogging app designed for tech enthusiasts. With Tech-Tweet, users can share their thoughts on technology, engage with others, and explore the latest trends in the tech world. This README will guide you through the features, installation, usage, and contribution guidelines for the project.
- User Authentication: Secure sign-up and login processes to protect user data.
- Post Short Tech Tweets: Share your thoughts in a tweet-like format.
- Commenting System: Engage in discussions by commenting on posts.
- Like/Dislike Posts: Express your opinion on tweets with likes and dislikes.
- Interaction Stats: View statistics on your posts and interactions.
- Responsive Design: Built with Bootstrap for a seamless experience on any device.
- Simple Feed: A clean feed to share ideas and connect with the community.
To set up Tech-Tweet on your local machine, follow these steps:
-
Clone the Repository:
git clone https://github.com/Emriss0/Tech-Tweet.git cd Tech-Tweet
-
Set Up a Virtual Environment:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install Requirements:
pip install -r requirements.txt
-
Set Up the Database:
- Make sure you have MySQL installed.
- Create a database named
tech_tweet
. - Update the
settings.py
file with your database credentials.
-
Run Migrations:
python manage.py migrate
-
Create a Superuser:
python manage.py createsuperuser
-
Run the Development Server:
python manage.py runserver
-
Access the App: Open your browser and navigate to
http://127.0.0.1:8000/
.
Once you have the app running, you can start using it by following these steps:
- Sign Up: Create an account by providing your email and password.
- Log In: Use your credentials to log in.
- Create a Tweet: Use the input box to share your tech thoughts.
- Engage with Others: Comment on tweets, and like or dislike posts.
- View Stats: Check the interaction stats on your profile.
- Django: The main framework for building the application.
- Python: The programming language used for backend development.
- MySQL: The database management system for storing user data and tweets.
- Bootstrap: For responsive and attractive UI design.
- HTML5/CSS3: For structuring and styling the web pages.
- JavaScript: For enhancing interactivity.
We welcome contributions to Tech-Tweet! If you want to help improve the project, please follow these steps:
- Fork the Repository: Click the "Fork" button at the top right of the repository page.
- Create a New Branch:
git checkout -b feature/your-feature-name
- Make Your Changes: Implement your feature or fix.
- Commit Your Changes:
git commit -m "Add your message here"
- Push to Your Fork:
git push origin feature/your-feature-name
- Create a Pull Request: Go to the original repository and click on "New Pull Request".
This project is licensed under the MIT License. See the LICENSE file for details.
To check for the latest releases, visit Tech-Tweet Releases. Here, you can download the latest version of the app and execute it on your machine.
Thank you for checking out Tech-Tweet! We hope you find it useful for sharing your tech thoughts and engaging with the community. If you have any questions or feedback, feel free to reach out or contribute to the project. Happy tweeting!