Giter Club home page Giter Club logo

studentapi_rayabasu's Introduction

Student Database (API)

This backend APIs responsible for loading student details with pagination, and implementing server-side filtering.

Tech Stack

Server: Express.js, Node.js, MongoDB Atlas, Cyclic(for hosting).

Tool: Postman, VS Code.

Features

  • Filtering
  • Sorting.
  • Searching.
  • Pagination.

Installation

Clone the repository:

  git clone https://github.com/RayaBasu01/StudentApi_RayaBasu.git

Deployment

To deploy this project run

  npm run dev

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

MONGODB_URI

Run Locally

Clone the project

  git clone https://github.com/RayaBasu01/StudentApi_RayaBasu.git

Go to the project directory

  cd my-project

Install dependencies

    npm install
    npm i express
    npm i mongoose
    npm i nodemon

Start the server

  npm run dev

FAQ

Where can I get MONGODB_URI?

To obtain the URL for database connectivity from MongoDB Atlas, follow these steps:

  1. Go to the MongoDB Atlas website and log in to your account.
  2. Navigate to the "Clusters" section and select the desired cluster.
  3. Click on the "Connect" button for the cluster.
  4. Choose "Connect Your Application" to get the connection string.
  5. Select your driver version and copy the provided connection string.
  6. Replace the <password> placeholder in the connection string with your MongoDB user's password.
  7. Optionally, customize the connection string with additional parameters like database name or SSL options.
  8. Use the modified connection string as the URL for connecting to your MongoDB Atlas database.

Ensure that you follow the appropriate security measures, such as using environment variables to store sensitive information like passwords, to protect your database credentials.

Is Cyclic free for hosting?

Yes, it has both free and paid version.

What are the steps of hosting?

At first signup to Cyclic and then connect your GitHub account to it. Then select the repo and enter the Environment variables required. After that start deploying and it will be live if the folder structure and the product is fine. Click on the link and enjoy your API.

Feedback

If you have any feedback, please reach out to us at [email protected]

studentapi_rayabasu's People

Contributors

rayabasu01 avatar

Stargazers

 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.