unicef / iogt-pwa

A UNICEF-led digital solution transforming lives and providing opportunity, by making knowledge universally accessible.

Home Page:https://www.internetofgoodthings.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

iogt-pwa

Documentation

Our wiki has several pages of information for developers, and people contributing to IoGT-PWA. Check it out for your authoritative source of information about the IoGT-PWA community.

Local installation

Activate your virtual environment (backend)

$ virtualenv iogt
$ source iogt/bin/activate

Install necessary dependencies & setup database (backend)

git clone https://github.com/unicef/iogt-pwa.git
cd iogt-pwa/iogt
pip install -r requirements.txt
cd ..

python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

The demo site will now be accessible at http://localhost:8000/ and the Wagtail admin interface at http://localhost:8000/admin/.

Log into the admin with the credentials you set while creating the superuser account.

Use Ctrl+c to stop the local server.

Setup yarn package manager (Depends on nodejs environment)

# May require administrator privileges to the command
npm install -g yarn 

Install necessary dependencies in a separate terminal window (frontend)

# Navigate to frontend folder
cd frontend

# Install frontend dependencies
yarn install

# Start a development server
yarn run dev

# Making a production build
yarn run build

Once the server has started, it will print a local development URL to open in your browser. Now you're ready to test drive IoGT website!

Agile development cycle

IoGT development team follows an agile development cycle as illustrated below in the steps to deliver working software as quickly as possible.

Agile development cycle diagram

Questions

For questions and support please use the community chat. The issue list of this repo is exclusively for bug reports and feature requests.

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Changelog

Detailed changes for each release are documented in the release notes.

Stay In Touch

Contribution

Please make sure to read the contributing guide before making a pull request.

Thank you to all the people who already contributed to IOGT-PWA!

License

GNU AFFERO GENERAL PUBLIC LICENSE

About

A UNICEF-led digital solution transforming lives and providing opportunity, by making knowledge universally accessible.

https://www.internetofgoodthings.org/

License:Other


Languages

Language:CSS 46.0%Language:TypeScript 33.7%Language:JavaScript 8.7%Language:Python 5.3%Language:HTML 5.2%Language:Dockerfile 1.0%