Giter Club home page Giter Club logo

student-database's Introduction

Student Database CRUD

STUDENT DATABASE is a MERN based CRUD application. Using this app you can perform 4 basic operations such as Create , update , read and delete operations on a simple Student database.

Appendix

/Backend : Contains data related to backend.

  • /db : Contains Configuration and User model.
  • /Routes : Contains API routes and Swagger docs.
  • /test : Contains Unit tests using Chai and mocha.
  • /.env : Contains PORT and mongodb connection string.
  • /index.js : Contains Swagger config and Express app.
  • /seed.js : Contains script to seed data.

/Frontend : React App

  • /src : Contains Components , assets and Css.
  • /.env : Contains Firebase Config , React app PORT

Run Locally:

  • Make sure you have Nodejs and mongoDb installed in your computer (Mongo db compass is recommended).
  • In mongodb copy the connection string and paste it inside the Backend/.env file in MONGODB_URI , make sure to follow the syntax.
  • I am using default 5000 port you can choose according to your machine.
  • Click on connect in mongodb compass to run the project.
  • Inside tha backend folder run command:
nodemon

Final Steps:

Clone the project

  git clone https://github.com/27Shri03/Student-Database.git

Go to the project directory

  cd Student-Database

Install dependencies

  npm install

Start the server

  npm run dev

Usage/Examples

Seed Script:

Using this file you can populate your database so that you can test API endpoints using Swagger API testing and work on the data initially.

  • In backend folder run this command:
node seed.js

On frontend , log in with the given email and password :

Swagger API testing:

After logging in with any account we can perform swagger API testing. Click on the Swagger API testing button to proceed with testing.

Running Tests

To run tests, run the following command in the backend folder

  npm test

Live preview

Student_database_project.mp4

student-database's People

Contributors

27shri03 avatar

Watchers

 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.