Skip to content

WikiMovimentoBrasil/capx-backend

Repository files navigation

logo of the Capacity Exchange The Capacity Exchange

The Capacity Exchange (CapX) is a project focusing on Global Approaches to Local Skills Development within and for the Wikimedia Movement. It establishes a sociotechnical platform for peer-to-peer connection and knowledge sharing to sustainably enable community-based capacity-building.

The aim is to create a methodology and service, which will serve as the structure for initiating mutual skills development globally, regionally, and locally. An interactive, online platform, backed by a database, will enable wikimedians to publish information about themselves, their affiliates, and informal groups. They will also be able to conduct searches, access information and to connect with each other in a way that reflects the Wiki's spirit and the Wikimedia Movement Strategy.

The Capacity Exchange (CapX) is available in Toolforge at https://capx.toolforge.org

Table of Contents

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Python 3

Installation

  1. Clone the repository:

    git clone https://github.com/WikiMovimentoBrasil/capx-backend.git
  2. Navigate to the project directory:

    cd capx-backend
  3. Create a virtual environment (optional but recommended):

    python -m venv venv
  4. Activate the virtual environment:

    • On Windows:
    venv\Scripts\activate.bat
    • On macOS and Linux:
    source venv/bin/activate
  5. Install project dependencies:

    pip install -r requirements.txt
  6. Create the database and apply migrations:

    python manage.py migrate

This will create a SQLite file in your source directory.

  1. Create a superuser to have full control over the database:

    python manage.py createsuperuser
  2. Install initial data:

    python manage.py loaddata fixtures/initial_data.json
    python manage.py loaddata fixtures/orgs.json
  3. Create a .env with the following envvars

    SOCIAL_AUTH_MEDIAWIKI_KEY="<YOUR MEDIAWIKI OAUTH KEY>"
    SOCIAL_AUTH_MEDIAWIKI_SECRET="<YOUR MEDIAWIKI OAUTH SECRET>"
    SECRET_KEY="<CREATE YOUR OWN RANDOM KEY>"

To create a new OAuth app and key, go to https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration . For local development, you can enable "This consumer is for use only by " and "User identify verification only".

  1. Start the development server:

    python manage.py runserver

You should now be able to access the project at http://127.0.0.1:8000/ in your web browser.

Contributing

Contributions are welcome! To contribute to the Capacity Exchange, follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Create a pull request on GitHub

License

This project is licensed under the GNU AGPLv3 - see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy