MaceNotes is a website where students can contribute and get notes and learn more from people you trust.
Eventhough platforms providing lecture notes are there, notes are not updated according to the latest syllabus and does not contains the whole portion. MaceNotes is a one-stop solution for all these problems. It serves as a platform where students can get Lecture Notes arranged according to their branch and year so they can prepare for exam in one night.
Project Managers, Developers, and Designers would be collaborating on various domains like:
-
UI Prototyping with figma tool figma design.
-
Front-End Development with ReactJS
This would be an enriching experience for all Student Developers, Project Managers, and Designers.
-
Coding Languages:
-
Tools & Technologies:
-
Project Management Tools:
Below is a basic idea as to how the website works. We will also be working on adding more features to this project!
-
Before working on any issue, kindly go through the instructions given in the contributing guidelines and readme the file carefully.
-
For each issue, a detailed explanation is mentioned in the issue ticket itself, for more details refer to figma design.
-
Code for different pages are arranged in seperate folders
Eg: src->Pages->CS
-
While making any component, make sure that the code for the all generalised/common components is kept in src->components folder.
-
Kindly keep the source code in the src->components folder while making specific components.
-
Please make sure to adhere to the folder structure of the project.
We will also be working on adding more features to this project.
Clone the repository -
git clone https://github.com/GDSC-MACE/MaceNotes
-
Run
cd MaceNoteson your CLI to navigate to the root folder -
Install the dependencies by running
npm install -
Run the server
npm start
Contributions of any kind welcome!