Skip to content

Minhnhat0408/Diligent

Repository files navigation

Contributors Forks Stargazers Issues MIT License Facebook


Logo

Social Media for self learning and fulfilling your potential
Report Bug · Request Feature

Note that the responsive is not completed so if you using a small screen device (~14inch) just zoom out a little.

Table of Contents
  1. About Diligent
  2. My Role
  3. Feature
  4. Roadmap
  5. Clone And Installation
  6. Contributing
  7. License
  8. Contact

About The Project

Diligent is a learning social media platform where everyone can be both teacher and student to other by asking questions and connect with people who contribute unique insights and quality answers. Moreover, The platform also offer many tools and utilities to aid the learning process, so look no further and join our community Diligent.

Benefits:

  • Connect everyone around the world to solve all the problems
  • Bring up motivation by streaks and rewards systems with fun activities through out the learning process
  • Express your idea, project and improve your overall insights

(back to top)

My Role

  • I'm the leader and fullstack dev of this project. Despite the fact that there is 4 other contributor in this project, all the work is actually done by myself (You can check in the contribution ). This is my spirit child, and I devote all I have in it, however there are still many bugs and feature I want to develop in the future so hopefully you guys can support me. Thanks alot

Built With

  • TailwindCSS
  • SASS
  • CSS3
  • React
  • Framer
  • React Router
  • Firebase

(back to top)

Feature

1. Sign in/Sign up with Google, Facebook or traditionally: project image

2. If create a fresh account you will need to fill in the information:

project image

3. Posting question and idea:

  • All basic function: post,delete , update, like, comment, save, hide, post.

  • The post will be suggested based on user preference (Category points). Hence your post will be seen by all the users who interests or have skill related. Also we suggested some friends in case you feel lonely :)

  • project image
  • You can also mention a specific person in your post. project image

  • Select a specific comment that is corrected or solved your problem. project image

4. User's Profile :

  • Information of user, all user's posts and rating for system badges. project image

5. Chat:

  • Chat page just like messenger and a chat shortcut for recent contact and notify if there is a messsage comming.
project image project image

6. Document's Storage:

  • Where everyone can upload their document, so that people can find and use.
  • All basic function like upload, delete, filter, search documents. project image

7. FlashCards:

  • Upload your decks of card that you want to learn.

    project image
  • Learning space with minimal distraction and user friendly UI.

  • The SRS algorithm (Anki's algo) is implemented to make sure you remember all the information with better UI than Anki.

    project image

8. Shorts:

  • Same like an stories from facebook but used for posting short and informative video.
  • Or just a place to flex some score and achievements.
  • Note that all shorts is expired after 24hr.
project image project image

9. Todo List:

  • List of tasks you will do today. You can add and reposition them for the priority. Note that all tasks will be delete after a day.
  • If the tasks can't be finish within that day, you can archived it until you finish or delete it.

project image

10. Streak record:

  • When you finish all the task in today(not delete them), that day will be counted as a productive day.

    project image
  • It will show your streak on the calendar.

project image

(back to top)

Roadmap

  • Add Flashcard Algorithm
  • Add Recommended Posts
  • Add Todo-list
  • Add firebase cloud function to delete realtime
  • Multi-language Support
    • Vietnamese
    • English

(back to top)

Clone And Installation

Clone the project

  git clone https://github.com/Minhnhat0408/Diligent

Go to the project directory

  cd Diligent

Install dependencies

  npm install
  yarn

Start the server

  npm start
  yarn start

Environment Variables

To run this project, you will need to add the following environment variables to your .env file All keys in firebase and setup a proper database for it. REACT_APP_API_KEY REACT_APP_AUTH_DOMAIN REACT_APP_PROJECT_ID REACT_APP_STORAGE_BUCKET REACT_APP_MESSAGING_RENDER_ID REACT_APP_APP_ID REACT_APP_MEASUREMENT_ID

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nguyễn Nhật Minh - @Minhatt048 - [email protected]

Project Link: https://github.com/Minhnhat0408/Diligent

(back to top)