anki2001ta / Edviron_Backend

EDVIRON BACKEND

Edviron is a platform that collects fees from students on behalf of schools.

🛠 Built with

Technologies used in the project:

💻 Glimpses

MongoDB:

LAMBDA

✨ Features

• Dynamic Data Management
• Proper Routing
• Dummy Database Collection
• Required Collection Maintained
• Used Lambda function to get Defaulter Data
• Monthly student's Payment management

Folders

DB /src

• Config
• Controller
• Model
• Routes
• Services

Config

• Config.js: This folder basically has a database connection with MongoDB

Controller

• feeheadController.js
• paymentcontroller.js
• studentcontroller.js
• transaction.js *This folder contains logic related to all the APIs

##Model

• Dues.js
• feehead.js
• installment.js
• invoices.js
• payments.js
• studentmodel.js
• transaction.js This folder contains a collection of all the required collections

#Routes -route.js: Contains the route of all the APIs

##Services

• studentservice.js : Contains logic for the student service

🚀 Demo

Front-end deployed URL:

• https://edviron-frontend-aeg8-o2xkv5okl-anki2001ta.vercel.app/

Back-end deployed URL:

• https://ill-red-dress.cyclic.cloud/

📁 Folder structure

• public - This holds all of our static files

• src

  • pages - These represent a unique page on the website i.e. Home or About.

  • App.js - This is what renders all of our browser routes and different pages

  • index.js - This is what renders the react app by rendering App.js.

• package.json - Defines npm behaviors and packages for the client

.gitignore - Tells git which files to ignore

README - This file!

Installation

Clone the project

git clone https://github.com/anki2001ta/Edviron_Backend.git

Client-side usage

Go to the project directory

$ cd edviron-backend       // go to client folder
$ yarn # or npm i               // npm install packages
$ npm run dev                // run it locally

// deployment for client app
$ npm run build  //This will compile the react code using Webpack and generate a folder called docs in the root level

✍ Contributors

• @anki2001ta