Skip to content

Arijit-017/ISTE-Contribution-React

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Display Project

This project showcases the data of our contributors, displaying information such as their name, location, bio, and social profiles.

Table of Contents

Getting Started

This project was bootstrapped with Create React App.

Prerequisites

Ensure you have Node.js installed on your machine. You can download it from here.

Installation

  1. Clone the repository:

    git clone https://github.com/Arijit-017/ISTE-Contribution-React
  2. Navigate to the project directory:

    cd ISTE-Contribution-React
  3. Install the required dependencies:

    npm install

Running the Application

  1. Run the application locally:

    npm start

    This will start the app in development mode. Open http://localhost:3000 to view it in the browser.

    The page will reload automatically if you make changes to the code.

  2. Build for production: When you're ready to deploy the application for production, build an optimized version:

    npm run build

    This will create a build folder with the production build.

Deployment

You can deploy this application on platforms like GitHub Pages, Vercel, Netlify, or Firebase. Below are the basic steps:

  • GitHub Pages:

    • Install gh-pages as a dev dependency:
      npm install gh-pages --save-dev
    • Add the following scripts to package.json:
      "scripts": {
        "predeploy": "npm run build",
        "deploy": "gh-pages -d build"
      }
    • Add a homepage field to package.json:
      "homepage": "https://your-username.github.io/repo-name"
    • Deploy the app:
      npm run deploy
  • Vercel:

    • Sign up or log in at Vercel.
    • Import your GitHub repository and deploy the app automatically.
  • Netlify:

    • Sign up or log in at Netlify.
    • Link your GitHub repository and configure the build settings. Use the following settings:
      • Build command: npm run build
      • Publish directory: build/
  • Firebase:

    • Install Firebase CLI:
      npm install -g firebase-tools
    • Initialize Firebase Hosting:
      firebase init
    • Deploy the app:
      npm run build
      firebase deploy

Built With

License

This project is licensed under the MIT License - see the LICENSE file for details.


You can directly copy and paste this Markdown into your `README.md` file. Let me know if you need further edits!