Skip to content

JTtime/adminUI-Challenge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

adminUI-Challenge

Contributors Forks Stargazers Issues MIT License LinkedIn Twitter


Logo

Admin UI Users Guide

Read this guide before before using. For Developers, refer Developers Guide in seperate file
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

This web app was created for the Geektrust frontend Admin UI challenge. It is a simple React App that allows users to view and edit information about a list of people.

So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to my learning and will be contributing in future!

(back to top)

Built With

This web application was built with React

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

To run this app locally, you'll need to have Node.js installed on your machine. check if its installed on your machine by

  • npm

    npm --version

Make sure to have latest version of npm

npm install npm@latest -g

Installation

  1. Clone this repository to your local machine.

    git clone https://github.com/JTtime/adminUI-Challenge.git
  2. In the project directory, Install NPM packages to install necessary dependencies and Run npm start to start the development server.

    npm install
    npm start
  3. Open http://localhost:3000 in your web browser to view the app.

  4. if your port 3000 is busy, then make necessary changes in package.json as follows

      "scripts": {
          "start": "PORT=8081 react-scripts start",}

    or you can keep any port number you want in place of 8081.

(back to top)

Usage

Once the app is running, you should see a list of people on the home page. Clicking on a particular checkbox will select a person's name(row). you can view and edit their information in-place, just by clicking edit button displayed as pen symbol This data is fetched from API endpoint provided by Geektrust: https://geektrust.s3-ap-southeast-1.amazonaws.com/adminui-problem/members.json Features on this app and their usage:

For detail regarding features and their usage, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jeevraj Taralkar - Twitter - [email protected]

Project Link: https://github.com/JTtime/adminUI-Challenge

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

About

Created with CodeSandbox

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published