The Women in Neuroscience Repository (WiNRepo)

This GitHub public repository stands for the development of the website of WiNRepo - https://www.winrepo.org.

Dependencies

All dependencies are listed in the requirements.txt file, stored in the root directory of the repository. To install them, you can run in the main directory:

pip install -r requirements.txt

Development

To contribute, please fork the repository. In the dev branch of your own repository, rename the file .env.default to .env. In order to have data to run the website, run the following command to generate a mock dataset:

./tools/refresh_db.sh

The local website uses SQLite, so there is no need to install any other dependencies. As you develop, if you would like to revert the changes you did to your local DB, you can run the command as much as you like. After setting up the DB, you can run the website locally using:

python manage.py runserver

and load the following page address in your browser: http://localhost:8000/.

Important:

1. Do not forget to hard reload the page to visualize your code changes.
2. Please check whether your new features work in all range of different devices by enabling the Responsive Design Mode in your browser.

Contributions Guidelines

To report a bug, suggest a new feature, add information or any other type of enhancement, please submit an issue. We will make all possible efforts to discuss and evaluate them with maximum brevity. When submitting a new Pull Request (PR), link it to the issues that it attempts to address through mention "Closes #XXXX".

PR Structure

1. Clear name
2. Clearly outline goals and changes proposed
3. Doesn’t include “unrelated” code change

Coding Style

1. Variables, functions, arguments must have clear names
2. Follows PEP 8 -- Style Guide for Python Code: https://www.python.org/dev/peps/pep-0008
3. Low redundancy
4. No new dependency