This is the Github repository for the entire caprende django project. It includes multiple individual applications as well as the linting executable, pylintrc, gitignore, and the pip requirements list.
These are the individual caprende modules that work together to create the website.
This is the main module that is created by default. This contains the url resolution file, the settings file, views file, and wsgi file.
This is the analytics application that contains the Category and Subcategory data set classes. It also has the map reduce functions for peer analytics.
This is the basic billing app. It stores all the braintree information, creates the basic plans, upgrades membership and allows users to upgrade and cancel the subscription.
This contains the Course and CourseSection class. Each course is created for any test. Individual sections obviously correspond to larger sections in the course or test itself.
This contains the Category and SubCategory class that both connect to the Course module. Each CourseSection has a set of Category objects and each of those corresponding Category objects has a set of SubCategories.
Each Question object is assigned to a SubCategory. This application also contains the QuestionResponse object. For every Question in a Course that a user answers, a QuestionResponse object is created. Based on the set of a user's QuestionResponse objects we create an analysis report.
This contains the main MyUser and UserProfile class. The UserProfile class is a ForeignKey object of the MyUser class. The MyUser class overwrites django-allauth default user class. The UserProfile class contains all the personal information regarding the user. The MyUser class contains the email, password, and username.
In this module we have a Comments object. Users can post comments on different Questions to help each other figure out the answer.
This is the basic notifications application. It allows comment notifications and admins to create notifications for different users based on new events.
Anytime there are any issues a Contact object can be created and filed and the administrators can respond to the email or User that creates it. Once an issue is resolved you can close and/or delete the issue.
Tip: Add a description to the README.md file for every application that is added.
Pre-Merge Check List:
- Run the "./lint" script to validate your commits pass the pylint check.
- Add a test infrastructure for your module. Run "python manage.py test" and make sure all tests pass.
- Create a branch in github using the following nomenclature /user/github_username/feature/feature_name and create a pull-request prior to merging.
- Register your github account SSH Key under Authorized Keys.
- Get access credentials to the caprende repository.
- Clone the repository using the following command. > "git clone [email protected]:av8ramit/caprende.git"
- A directory named caprende should have been created. Now create a virtual environment with the following command. > "virtualenv caprende"
- Activate the virtual environment with the following command. > "cd caprende; source bin/activate"
- Enter the src directory and run the following command to launch the mock website at http://127.0.0.1:8000/ > "python manage.py runserver"