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
8439fa56bc
FOSSDB/README.md
Kristofers Solo 8439fa56bc Added lint to README
2023-04-12 10:47:54 +03:00

1.7 KiB
Raw Blame History

FOSSDB

License
Tests
Lint

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. Run database migrations:
python manage.py migrate
  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.