updated readme.md
This commit is contained in:
74
README.md
74
README.md
@@ -1,44 +1,36 @@
|
||||
# Reddit, but it's all cats!
|
||||
## React/Redux project developed by Mikayla Dobson
|
||||
|
||||
This project was completed as a portfolio project in Codecademy's Full Stack Engineer Pro course!
|
||||
|
||||
The goal of this project was to build a read-only client for browsing Reddit, allowing the user to read data from posts, view discussion threads, and search posts within the feed.
|
||||
|
||||
In order to make this project my own, I populated my feed with content from some of my favorite cat related subreddits.
|
||||
|
||||
Additional features implemented include:
|
||||
|
||||
- Ability to toggle subreddit visibility in the sidebar
|
||||
- Displays certain addition post and discussion metadata
|
||||
- Optimized rendering with subsections of the total feed, by page of 20 posts
|
||||
- CI/CD and Web Hosting with Netlify
|
||||
|
||||
## Changelog:
|
||||
|
||||
### Version 0.1, 01/30/2022
|
||||
|
||||
First project build!
|
||||
|
||||
Many features still need to be built out, but much of the initial functionality exists, including:
|
||||
|
||||
- Post rendering
|
||||
- Media rendering
|
||||
- Discussion thread rendering
|
||||
- UI design
|
||||
|
||||
------
|
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) template.
|
||||
|
||||
## Available Scripts
|
||||
All associated developer scripts apply.
|
||||
|
||||
In the project directory, you can run:
|
||||
|
||||
### `npm start`
|
||||
|
||||
Runs the app in the development mode.<br />
|
||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||||
|
||||
The page will reload if you make edits.<br />
|
||||
You will also see any lint errors in the console.
|
||||
|
||||
### `npm test`
|
||||
|
||||
Launches the test runner in the interactive watch mode.<br />
|
||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
||||
|
||||
### `npm run build`
|
||||
|
||||
Builds the app for production to the `build` folder.<br />
|
||||
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.<br />
|
||||
Your app is ready to be deployed!
|
||||
|
||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/getting-started).
|
||||
|
||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
||||
Related documentation can be found [here]((https://facebook.github.io/create-react-app/docs/getting-started)).
|
||||
Reference in New Issue
Block a user