AEC Coding Club Community Website 

This is the student-run community site and event management webapp for the Coding Club of Asansol Engineering College using React, Express and MongoDB.

💻 Getting started

The frontend was bootstrapped with Create React App. In the project root directory, run npm install to install all project dependencies. Next, run npm start to start the developmental server which will trigger open your default browser to localhost:3000. Run npm install and npm run dev in Backend directory to set up the Express server.

To set up frontend...

Add .env file in root and write:

REACT_APP_SERVER=http://localhost:4000/api/v1/

React app routers:

/                         -> src/Pages/Home.jsx
  /events                 -> src/Pages/Events.jsx
  /members                -> src/Pages/Members.jsx
  /signup                 -> src/Pages/Signup.jsx
  /signin                 -> src/Pages/Signin.jsx
  /entermail              -> src/Pages/Enteremail.jsx
  /verify                 -> src/Pages/OTP.jsx
  /setNewPassword/:token  -> src/Pages/Setpassword.jsx
  /dashboard              -> src/Pages/Dashboard-Secure.jsx
  /admin                  -> src/Pages/Components/User-Secure-Route/Admin Panel/Admin.jsx
    /admin/overview       -> src/Pages/Components/User-Secure-Route/Admin Panel/Pages/AdminOverview.jsx
    /admin/admin-users    -> src/Pages/Components/User-Secure-Route/Admin Panel/Pages/AdminUsers.jsx
    /admin-events         -> src/Pages/Components/User-Secure-Route/Admin Panel/Pages/AdminEvents.jsx
    /admin-logs           -> src/Pages/Components/User-Secure-Route/Admin Panel/Pages/AdminLogs.jsx
    /admin-stats          -> src/Pages/Components/User-Secure-Route/Admin Panel/Pages/AdminStats.jsx
  /*                      -> src/Pages/Errorpage.jsx

Express Server API:

General:
[GET]
        • /
        • /*

Logs:
[GET]
        • /api/v1/logger
        • /api/v1/branchdata
        • /api/v1/yeardata
        • /api/v1/alluser
        • /api/v1/eventsdata
[POST]
        • /api/v1/updateuser/:id

Authentication:
[GET]
        • /api/v1/dummy
        • /api/v1/dashboard
        • /api/v1/dashboardtry
[POST]
        • /api/v1/register
        • /api/v1/login
        • /api/v1/verify
        • /api/v1/dummy
        • /api/v1/tokenforreset
        • /api/v1/setNewPassword/:token

Events:
[GET]
        • /api/v1/events
        • /api/v1/:id
[POST]
        • /api/v1/add
        • /api/v1/registerevent:id
        • /api/v1/announceall
[PUT]
        • /api/v1/update/:id
[DELETE]
        • /api/v1/delete

⚒️ Tools and Frameworks

✨ Contributing

By contributing to this repository, you adhere to the rules in our Code of Conduct. Here are a few general instructions for people willing to develop onto the codebase.

• Create issues to discuss your ideas with the maintainers

Creating issues before starting to work on your pull request helps you stay on the right track. Discuss your proposal well with the current maintainers.

• Keep the code clean

AECCC members will read your code long after you've graduated. Don't hurt their eyes. Follow the code formatting standards of the repository by referring to existing source files.

• Comments are the best

Make it clear what hacks you've used to keep this website afloat. Your work needs to be understood first, before getting appreciated (or criticised).

• Keep the Contributors section up-to-date

Just so that everyone knows whose fault it is if things get screwed up.

👨‍💻 Our valuable Contributors

This project is made possible by our valuable contributors .Thanks to all the People Who Contribute.

Repository structure

Prettyprinted ASCII project directory tree in docs/TREE.md

📜 License

MIT License Copyright (c) 2022 AEC Coding Club