Giter VIP home page Giter VIP logo

dansanders_student_roster's Introduction

Student Roster

Getting Started

  1. Click "Use This Template" and "Create a new repository."
  2. Clone down your repo and run npm install.
  3. Create a .env file according to the provided example.env.
  4. Apply the initial Prisma migration and generate the client.
    npx prisma migrate reset
  5. Start developing!
    npm run dev

Architecture

Backend

The backend consists of an Express server with a SQLite database and Prisma as the ORM. The entrypoint is src/server/index.js.

API routes can be found in src/server/api/.

To seed database, do the following:

  • create .env file in root directory using the code from example.env from the template.
  • in your terminal run the following commands:
    • npm i
    • npx prisma migrate dev
  • Use npx prisma studio to view database

Database schema as described below

Expand to see DBML
Table Student {
  id        Int      [pk]
  firstName String   [not null]
  lastName  String   [not null]
  email     String   [unique]
  imageUrl  String   [default("blank_image")]
  gpa       Float    
}

Frontend

The frontend is a React app created with Vite. Vite middleware is used in development, but the frontend should be built for production.

Routing is handled with React Router. The router is defined in src/client/main.jsx.

Application state is managed with Redux Toolkit. The store is defined in src/client/store/index.js. Additional slices should be defined separately in src/client/features.

RTK Query is used to handle data fetching. The central API slice is defined in src/client/store/api.js and is intended to stay empty. Additional endpoints should be injected separately in src/client/features.

Less is used as the CSS preprocessor.

dansanders_student_roster's People

Contributors

erinwolff avatar danders929 avatar mfernandez1255 avatar jyudkovsky avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.