This project was bootstrapped with Create React App.
It has been ejected to allow for better file structure.
- Installed dependencies:
npm install - Start Postgres:
docker-compose up -d - Create a .env file with your database information. By default you may use this:
DB_HOST=localhost DB_PORT=5432 DB_USER=postgres DB_PASS=changeme DB_APP=gists
- Run the application:
npm run start
You may get node-gyp errors when running npm install. If this is the case, you may need to install g++ and build-essentials.
The following items are available in the application for use by developers.
Thie application features a GraphQL API. Graphiql is available at
http://localhost:5000/graphql
Postgres may be started with docker-compose up -d. If you have your own instance setup, you may configure it in .env.
PgAdmin is available at http://localhost:5050. You may find the credentials in the docker-compose.yaml file.
All source files are under /src. Server side files are under /src/server and client files under /src/client.
On the server side, entities are grouped in their own folders with GitHub API functionality going under lib.
On the client side, components are listed under the components folder with their CSS and an index.js.
CSS classes mapping to a component name are capitalized with camel-case to show they're the root class of a component.
Other CSS classes are snake-cased.
Ugh. It didn't all get done.
- The ability to save query favorites.
- Paging large numbers of items. The page limits are set by the GitHub API.
- Robust error handling.
In the project directory, you can run:
Under the hood, this calls npm start-server and npm start-client concurrently.
Runs the client 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.
Runs the server app in the development mode.
Open http://localhost:5000/graphql to view Graphiql it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify