Todo
[x] Modal search box in Home page when clicking the search icon in header
[ ] Study about creating charts in react
[x] Improve page styling
MVP:
[ ] Show charts in a dashboard view in Home page (using chart.js or similar) (Projects p/area, most used technologies, number of students p/area etc...)
[x] Search projets by name, technology and area
[x] Display a page for each project, showing all related informations (students, area, description, tecnologies, finish ratio and current status)
[x] Add photo to project
[x] Add, edit and delete projects
[ ] Follow bosch brandguides
[ ] About us page
[ ] Local storage auth
Post-MVP:
- Students can add/edit/delete/view comments to indicate more information about the project finish ratio
- Working login and sign up users auth
- Project Rating
- Different types of users, normal vs admin
- Admin registration email confirmation
- Dark mode
- Display a page for each user, showing all related informations
- Display a page for each area, showing all related informations
- Export database to CSV
- First, install all project dependencies:
npm install
# or:
yarn- Then run the development server:
npm run dev
# or if you used yarn in the first step:
yarn dev- Open http://localhost:3000 with your web browser.
MVP:
[x] Create initial project structure
[x] Do models, schemas, endpoints and CRUD of the API
[x] Implement image to projects database
[x] Deploy API to heroku
[x] Test all endpoints
[x] Create a script to auto generate the documentation
Post-MVP:
- Implement tables for students, projects and admins (ManytoMany relationship)
- Make possible to add multiple images to a project (Image array)
- Students rating to each project
- Login and sign up users auth
- A single table to show info to the dashboards
- Admin registration email confirmation
- Export database to CSV
- Migrate database to PostgreSQL
- First, create virtual environment:
py -m venv venv
# or:
python3 -m venv /path/to/new/virtual/environment- Activate venv:
#in windows
.\venv\Scripts\activate
# or if you using linux distros:
source venv/bin/activate- Install all packages:
pip install -r .\requirements.txt- Run the server with:
uvicorn main:app --reload- Open http://localhost:8000 with your web browser.