All your Cheatsheets, Reference Books and Practice Papers, at One Place!
Documentation

View a Live Demo · Report a Bug · Request a Feature

This is the official project repo for SCL-Maxo, a 40-day Hackathon organised by Sushiksha, World Konkani Center.
The repo is monitored and only members from team Tejas are allowed to make changes. 
Thus, we will not be accepting any PRs from anyone apart from team members. 
For further details, you can get in touch with the repo owner or contributors. 

1. Backend Framework: Django
2. Front-end Framework: Bootstrap
3. Database used: Sqlite

1. Fork and Clone

   1. Fork the Tejas-SCL-maxo Repository
   2. Clone the repo to your local system.

2. Create a Virtual Environment for the Project

   In Windows

   pip install virtualenv
   virtualenv venv
   venv\Scripts\activate

   In Ubuntu/MacOS

   python -m virtualenv venv
   
   source venv/bin/activate

   If you are using another name for the virtual environment other than venv, then please mention it in .gitignore.

3. Install all the requirements

   pip install -r requirements.txt

4. Checkout to a different branch

   git status
   git pull
   git branch
   git checkout -b <your-branch-here>
   

5. Make migrations/ Create db.sqlite3

   python manage.py makemigrations
   python manage.py migrate

6. Create a super user. In Django, if you want to access admin page, you need to create an account with staff status first.

   python manage.py createsuperuser
   

   Then select your username and password. You can bypass a common password for development purposes.

7. Run the server on localhost:

   python manage.py runserver

8. Make the changes and send a PR, referencing the changes.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change in the project.

You can create an account on NoteRepo by clicking on the Log In button on the top right corner of the Main Page

Once in, you should see a Sign In screen. If you already have an account, you can Sign In directly from here. You can also Sign In through sites like Facebook, GitHub, Google or LinkedIn (Note: Some functions could still be under development) Else, you can click on the Sign Up button towards the left to Sign Up to NoteRepo.

Once in the Sign Up screen, you can fill in basic details like username and you E-Mail to sign up to NoteRepo. You can also Sign Up through sites like Facebook, GitHub, Google or LinkedIn (Note: Some functions could still be under development)

Note: You may be redirected to the Sign In page after signing up. You can sign in by re-entering the details you provided during sign up.

Once Logged in, you should be seeing the following landing page. If you do not however, try logging in again.

To log out, click on the the Profile option on the Navigation Bar towards the top right.

This will open up the profile section. From here click on your username on the top right.


From the drop-down menu, click on Logout. This should log you out and take you make to the Home Page.

Once logged in, the landing page will the first thing you will see. This is the hub of the website which includes various option.

Navigation Bar

• Home - Takes you to the Home Page(current page)



• About Us - Takes us to the about us section of the page




• Forums - Takes you the forum section of the page (under development)



This Feature is currently under Development



• Contact Us - To send us a message



This Feature is currently under Development



• Profile - Takes you to the profile section

Main Page

• Notes - Takes you to the Cheatsheets/Notes section




• References - Takes you to the References/textbooks section




• Papers - takes you to the Question papers section

You can View and Download any of the listed books by clicking on Download. The links will take you to Google PDF Links and all options provided by Google PDF viewer will be available (requires you to login to you Google account)

1. The search function is currently under development.
2. The add button is currently under development.

This Feature is currently under Development

This Feature is currently under Development

In this section, the user will be able to add details about himself. All of this data is kept private and not shared with anyone.

This section requires superuser status or staff user permission to be accessed. to know more, visit the Creating a super user section in the Development tab above.

After this you can visit the admin section by adding admin to the end of the url after host eg: 127.0.0.1:8080/admin

1. Through the normal Sign In page. This directly adds users to the admin section
2. Adding users through the admin section:
   1. Go to the admin section by following the instructions above.
   
   
   
   
   2. Select the users section on the left then select add users on the top right
   
   
   
   
   3. Here you can add details of the user and they will be registered as a user.
   
   
   
   

Adding resources like Cheatsheets, Reference books and question papers can only be done by Super Users or users with Staff Status and via the Admin section. Refer details about Admin section and Creating a super user above.

1. Visit the Admin section




2. Choose any of the options from Q Papers, Notes, Textbooks




3. Once selected, you will be presented with a form of details to fill for each of the 3 addable resources, you can fill these up and this, will add a new addab;e to the table.