EduMaterials is an Documentation Template with Authentication Created for TYMaterials Webstite
- Responsive Material UI
- Documentation
- Automatic Table of Contents
- Authentication Functionality with Firebase Auth
- Dynamic Sidebar
- Dark Mode Accessibility
- PostgreSQL
Follow these steps to install and run the project locally:
-
Clone the repository to your local machine using
git clone https://github.com/GautamPatil1/EduMaterials
. -
Navigate to the project directory using
cd EduMaterials
. -
Install the necessary dependencies. If you're using npm, run
npm install
. If you're using yarn, runyarn
. -
Set up your Firebase and PostgreSQL configurations. You'll need to replace the placeholders in the
firebase.json
and the PostgreSQL connection string with your actual configuration details. -
Once the setup is complete, start the server. If you're using npm, run
npm start
. If you're using yarn, runyarn start
. -
Open your browser and navigate to
http://localhost:3000
(or whatever port you've configured) to see the application running.
Contributions are welcome!
This project is licensed under the terms of the MIT license. See the LICENSE file for details.