School tracking application

Table of Contents

• About the Project
• Description
• Built With
• Live Demo
• Getting Started
• Testing
• Authors
• Contributing
• Show your support
• License
• Acknowledgements

About the Project

This is a web application to track the evolution of school students in the curriculum.

The front end is built with React and Redux.

The back end is built with Ruby on Rails and has been deployed to Heroku

PostgreSQL is the database employed to store the data.

Description

There is a menu where you can select:

• Classroom: Here you can see all the classrooms of the school
• Curriculum: To see all the topics that are included in the curriculum
• Subareas: The main categories in which the topics are divided

Classrooms

If you select one of the classrooms you can get a list of all the students that belong to that classroom. In any of these students, there is a link to get all the scores assigned to that student.

Curriculum

If you select one of the topics you will get all the subareas in which that topic is divided. If you click in any of these subareas you will get all the exercises that belong to that subarea.

Subareas

If you click in any of the subareas you will get a list with all the exercises that are included in that subarea.

The scores are classified this way:

• /: Close
• ꓥ: Reached
• 𐊅: Exceeded

Built With

• JavaScript
• React
• Redux
• Node package manager
• Ruby
• Ruby on Rails
• HTML5
• CSS

Live Demo

Live Demo Link

Getting Started

To get a local copy up and running follow these simple example steps.

1. On the project GitHub page, navigate to the main page of the repository.
2. Under the repository name, locate and click on a green button named Code.
3. Copy the project URL as displayed.
4. If you're running the Windows Operating System, open your command prompt. On Linux, Open your terminal.
5. Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
6. Type git clone, and then paste the URL you copied in Step 3.
   e.g. $ git clone https://github.com/Zappat0n/school-tracker.git
7. Press Enter. Your local copy will be created.
8. On your console, move to the place where this folder is cloned
9. Create a file named .env in the root folder of the application with the following lines
   REACT_APP_SERVER=[address of the backend]
REACT_APP_CLIENT_ID=[id of the application in the backend]
REACT_APP_CLIENT_SECRET=[secret of the application in the backend]
10. Run npm start, then the server is automatically opened

Getting Started

To test the project you just need to run npm run test.

Authors

👤 Angel Barros

• GitHub: @Zappat0n
• LinkedIn: LinkedIn

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Show your support

Give a ⭐️ if you like this project!

License

This project is MIT licensed.

Acknowledgements

• React
• Redux
• Ruby on Rails