TemariSync is a web application designed to manage, organize and share academic resources among students. It provides a user-friendly interface for users to interact with their data.
Link to deployed site Here
Link to Blog about TemariSync
Author Yeabsira Desalegn: LinkedIn
- User authentication: Users can log in to access their data. Unauthorized access is prevented.
- Assignments, Projects, and Materials: Users can store their resources remotely in an organized manner.
- Seamless access to your materials, you can retrieve documents instantly, whether you're at home, in the library, or on the go.
- Share resources with peers, students can share their documents with their peers with ease
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- A modern web browser
- A server to host the application
- A webserver configured to reverse proxy to the app
- The MySQL database root user should be properly configured.
- Clone the repository to your local machine or server and navigate to the cloned repository.
- Install required packages by running
setup-env.shwith root privileges. - Unless you want to use custom database configurations, set up the default database by running
cat database.sql | mysql -u root -p
- If you are going to use custom database configurations, edit
run-api.shto modify database configurations. Otherwise, proceed to the next step. - Generate a secret key to be used to encrypt session cache. It is recommended to use a strong random string.
- Start the API with
SECRET_KEY='Your Secret Key' ./run-api.sh - Finally, start the front-end by running
run-app.sh - Now the app should be ready to go. Navigate to the domain you configured and access it.
- Log in with your user credentials or create a new User.
- Use the navigation links to access the site accordingly.
- Click the logout button to log out of your account.
The application uses the following API endpoints:
Check all API endpoints here
We welcome contributions from the community to help improve TemariSync. If you have any ideas, bug reports, or feature requests, please feel free to contact us or submit a pull request. We appreciate your support in making TemariSync even better!
This project is open source and available under the MIT License.