kristoferssolo/FOSSDB
1
0
Fork 0
mirror of https://github.com/kristoferssolo/FOSSDB.git synced 2025-10-21 17:50:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
228 Commits 3 Branches 0 Tags 410 KiB
Python 55.1%
HTML 35.4%
JavaScript 8.2%
CSS 1.3%
main
Go to file
Kristofers Solo 2945c999b5 Added config.json file
2023-09-09 23:53:40 +03:00
.github/workflows Fix test.yml 2023-06-29 03:01:12 +00:00
src Merge branch 'fossdb' 2023-06-30 14:34:58 +00:00
.gitignore Added config.json file 2023-09-09 23:53:40 +03:00
config.json Added config.json file 2023-09-09 23:53:40 +03:00
config.json.example Create example config file 2023-06-16 19:27:32 +03:00
LICENSE Initial commit 2023-03-15 23:57:51 +02:00
pyproject.toml Update pyproject.toml 2023-09-09 23:49:30 +03:00
README.md Update pyproject.toml 2023-09-09 23:49:30 +03:00
requirements_dev.txt Fix vulnerabilities 2023-09-09 23:52:05 +03:00
requirements.txt Fix vulnerabilities 2023-09-09 23:52:05 +03:00

README.md

FOSSDB

FOSSDB is an open-source web application that helps users find, contribute, and collaborate on free and open-source software (FOSS) projects.

Table of Contents

Installation

  1. Clone the repository and cd into it.
  2. Install dependencies:
pip install -r requirements.txt
  1. Enter your SECRET_KEY and database information into config.json file.
  2. Install and build tailwind.
python manage.py tailwind install

python manage.py tailwind build
  1. Run database migrations:
python manage.py migrate
  1. Collect static files
python manage.py collectstatic
  1. Create a superuser:
python manage.py createsuperuser
  1. Run the development server:
python manage.py runserver

Usage

After following the installation steps, you can access the application at https://localhost:8000. Here are some of the features:

  • Browse projects by programming language, license, or search term
  • View project details, including programming languages, licenses, and descriptions
  • Create a new project and add programming languages and licenses
  • Edit and delete existing projects

Contributing

Contributions are always welcome! Here are some ways to get started:

  1. Fork the repository and make your changes.
  2. Submit a pull request.
  3. Respond to open issues or submit new ones.
  4. Improve documentation.

License

This project is licensed under the GPL3 License. See the LICENSE file for details.