Forum is a web application that allows users to create, view, and participate in discussion threads on various topics. It is not jet dedicated to a specific topic
To install and run Forum on your local machine, follow these steps:
-
Clone the repository to your computer
-
Create a virtual environment
python -m venv venv -
Enable the virtual environment
For macOS bash or zsh:
`source venv/bin/activate` -
Install requirements in virtual environment
`pip install -r requirements.txt` -
Initialize database
`flask db init` `flask db upgrade` -
Create a
.envfileIt should contain:
DATABASE_URL=sqlite:///database.db,FLASK_APP=run.py,SECRET_KEY=to be defined -
Run the app to see if it is working
`python run.py`
To use Forum, simply create an account or log in to an existing account. You can then browse existing threads or create your own threads on various topics. You can also participate in discussions by replying to existing threads or comments.
We welcome contributions to Forum! If you would like to contribute, please follow these steps:
- Fork this repository
- Create a new branch for your changes:
git checkout -b my-new-branch - Make your changes and commit them:
git commit -m "Add new feature" - Push your changes to your forked repository:
git push origin my-new-branch - Submit a pull request to the original repository
Please ensure that your changes follow our coding standards and are thoroughly tested before submitting a pull request.
If you have any questions or comments, please feel free to contact us by opening an issue on this repository.
Forum uses the following external libraries and resources:
- Flask
- SQLAlchemy