Skip to content

Commit

Permalink
🎯Added GOALS.md
Browse files Browse the repository at this point in the history
🔀Added DB_Diagrams.md
  • Loading branch information
Prater-12 committed Oct 29, 2023
1 parent 5875638 commit 8607bd3
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 0 deletions.
42 changes: 42 additions & 0 deletions GOALS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Goals <!-- omit from toc -->

A rough list of all the goals to meet in our current plan for this project.

- [Authentication](#authentication)
- [Projects Page](#projects-page)
- [Dashboard](#dashboard)
- [Mentor Registraion](#mentor-registraion)
- [Mentee Registration](#mentee-registration)

## Authentication

- [ ] Implement basic authentication
- [ ] Back-end
- [ ] Front-end
- [ ] Implement logout functionality

## Projects Page

- [ ] Pages for displaying projects (past + current)
- [ ] Card-based list view
- [ ] Project detail view

## Dashboard
- [ ] Mentor Registration View
- [ ] Mentee Registration View
- [ ] Mentor Dashboard
- [ ] Mentee Dashboard

## Mentor Registraion

- [ ] Basic project submission
- [ ] API endpoints
- [ ] Webpage
- [ ] Allow Google Forms like **auto-save**

## Mentee Registration

- [ ] Basic mentee registration
- [ ] API endpoints
- [ ] Webpage
- [ ] _"Add to Preferences"_ button on project's detail page for mentee registrations
78 changes: 78 additions & 0 deletions backend/DB_Diagram.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Database Entity Relationship Diagram
> An entity–relationship model (or ER model) describes interrelated things of interest in a specific domain of knowledge. A basic ER model is composed of entity types (which classify the things of interest) and specifies relationships that can exist between entities (instances of those entity types). - Wikipedia
This is a diagram that shows the current database schema, generated based on the app's models.

```mermaid
---
Django ER Diagram
---
erDiagram
User {
BigAutoField id
CharField password
DateTimeField last_login
BooleanField is_superuser
CharField roll_number
CharField first_name
CharField last_name
CharField email
BooleanField is_staff
BooleanField is_active
DateTimeField date_joined
ManyToManyField groups
ManyToManyField user_permissions
}
Season {
BigAutoField id
CharField name
BooleanField is_active
IntegerField status
}
Project {
BigAutoField id
DateTimeField created
CharField title
ForeignKey season
CharField category
IntegerField mentee_min
IntegerField mentee_max
TextField abstract
TextField description
TextField timeline
FileField banner_image
BooleanField is_accepted
ManyToManyField mentors
}
MentorRequest {
BigAutoField id
ForeignKey mentor
ForeignKey project
IntegerField status
}
Mentee {
BigAutoField id
ForeignKey user
ForeignKey season
ForeignKey project
ManyToManyField preferences
}
MenteePreference {
BigAutoField id
ForeignKey mentee
ForeignKey project
TextField sop
IntegerField ordering
}
Project }|--|| Season : season
Project }|--|{ User : mentors
MentorRequest }|--|| User : mentor
MentorRequest }|--|| Project : project
Mentee }|--|| User : user
Mentee }|--|| Season : season
Mentee }|--|| Project : project
Mentee }|--|{ Project : preferences
MenteePreference }|--|| Mentee : mentee
MenteePreference }|--|| Project : project
```

0 comments on commit 8607bd3

Please sign in to comment.