Microsoft Student Partners

This is the unofficial website for the Microsoft Student Partners

:License: MIT

Setup

1. Clone the repository

   $ git clone https://github.com/ramanaditya/Microsoft-Student-Partners

2. Create a virtual environment using virtualenv or venv.

   $ virtualenv -p python3 venv/ 
   $ source venv/bin/activate

3. Install python packages

   $ pip3 install -r requirements/local.txt

4. Install OS dependencies (For linux systems only, others have to install it manually)

   $ sudo ./utility/install\_os\_dependencies.sh install

5. Makemigrations and migrate

   $ python manage.py makemigrations
   $ python manage.py migrate

6. Run project locally

   $ python manage.py runserver --settings=config.settings.local

Settings

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create an superuser account, use this command::

  $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy microsoft_student_partners

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report::

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation_.

.. _Live reloading and SASS compilation: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Issues

// No Issues now.

NOTE: Feel free to open issues. Make sure you follow the Issue Template provided.

Contribution Guidelines

• Write clear meaningful git commit messages (Do read this).

• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)

• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)

• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

• Please follow the PR Template to create the PR.

• Always open PR to develop branch.

• Please read our Code of Conduct.

• Refer this for more.

If you like this repository, support it by star 🌟