Skip to content

Latest commit

 

History

History
115 lines (70 loc) · 4.62 KB

README.md

File metadata and controls

115 lines (70 loc) · 4.62 KB
Raw

GitGenie 💡

A tool to allow anyone to search for repos created by a user or organisation

Features! 💻

  • Responsive mobile design
  • Uses React on the front end (create-react-app), with Hooks!
  • Uses Express on the backend
  • Makes github API calls via backend server
  • Validation

ToDo's 🔧

  • Write Tests
  • Error Handling UI - (so far the code catches errors but UI not built)
  • Improve design
  • Fix bugs
  • Allow filtered searches (eg repos made in the last 7 days)

Key Learning Takeaway's 📚

Thank you for giving me this project. I spent a few hours each day over about 5 days to build it. I am grateful because..

  • I had never used React's Hooks before. I spent most of the time learning how to use them, and I am happy that I now feel confident using Hooks. I figured that because I want to learn React Native, why not start now and implement hooks! Hooks are very fun once you learn to adapt your thinking.
  • I really enjoy design. I loved coming up wirth the idea of a git Genie , and playing on this theme. I want to become a design pro.
  • I want to learn about best practises for Hooks. I played around with having several state hooks versus a single object, and I am unsure of the best way. Also, balance between component splitting is key. I sometimes overdid component splitting; which is great for writing tests and reusable UI, but perhaps not necessary for a small project.

Tech

GitGenie uses a number of open source projects to work properly:

  • [Styled Components] - Makes it easy to style with JavaScript in React!
  • [Node Fetch] - awesome node based Fetch API

Installation

Install the dependencies and devDependencies and start the server.

$ cd git-genie
$ npm i
$ npm start

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

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

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

License

MIT