diff --git a/README.md b/README.md index 9c40dcd..0cf260d 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,33 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +# Contacts Frontend with Create React App -## Available Scripts +## Description -In the project directory, you can run: +This is a frontend *only* react app consuming a third-party API. In particular, this react app is consuming the Django REST API created [here](https://github.com/jlboba/django_rest_api), but this format will work for any seperate server API regardless of what language you built it in. -### `yarn start` +--- -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +## Get Set Up Locally -The page will reload if you make edits.
-You will also see any lint errors in the console. +### On your Browser -### `yarn test` +1. Fork this repository to your account -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +### In your Terminal -### `yarn build` +1. Clone **your fork** of the repo onto your computer anywhere that is not a git repo +1. `cd` into the repo +1. Touch a `.env` into the root of your project and add a REACT_APP_API_URL value wih the URL to your API. See the .env.sample file for an example of how to set it up + - Your URL can either be local if you're testing your local API or the deployed url if you're testing the deployed API +1.Install all the required packages by running: `yarn install` +1. Run the app by running `yarn start` and you should now be able to see the app on localhost:3000 -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! +## Deployment -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +Deployment with create-react-app is fairly straightforward. You can see the full deployment docs from CRA here and take your choice of where you want to deploy it, then follow their instructions: https://create-react-app.dev/docs/deployment -### `yarn eject` +My suggestions for deployment, use either of these two: -**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](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### 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 - -### `yarn build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +- [Netlify](https://create-react-app.dev/docs/deployment/#netlify) +- [Heroku](https://create-react-app.dev/docs/deployment/#heroku)