Update README.md
This commit is contained in:
ilyas
GitHub
parent
9b70dbf90f
commit
b0d694df88
90
README.md
90
README.md
@ -1,68 +1,84 @@
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
# Logster - login/register-page-app
|
||||
|
||||
## Available Scripts
|
||||
> Simple login/register-page-app created with React js.
|
||||
|
||||
In the project directory, you can run:
|
||||
Logster is a React app that has a Login, Register and Reset password features. This is just the Front-end of the app, no Back-end.
|
||||
|
||||
### `npm start`
|
||||
## Table of contents
|
||||
* [Functionalities](#functionalities)
|
||||
* [Technologies](#technologies)
|
||||
* [Live App](#live-app)
|
||||
* [Packages & Libraries](#packages-&-libraries)
|
||||
* [Contributing](#contributing)
|
||||
* [Support](#support)
|
||||
* [Final Words](#final-words)
|
||||
* [License](#license)
|
||||
|
||||
Runs the app in the development mode.<br>
|
||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||||
## Functionalities
|
||||
|
||||
The page will reload if you make edits.<br>
|
||||
You will also see any lint errors in the console.
|
||||
* Login with username and password
|
||||
* Create an account
|
||||
* Reset password
|
||||
|
||||
### `npm test`
|
||||
## Technologies
|
||||
|
||||
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.
|
||||
* React js
|
||||
* HTML5
|
||||
* CSS3
|
||||
|
||||
### `npm run build`
|
||||
## Live App
|
||||
|
||||
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.
|
||||
To view and test the app you can visit this [link](https://logsterapp.netlify.com/).
|
||||
|
||||
The build is minified and the filenames include the hashes.<br>
|
||||
Your app is ready to be deployed!
|
||||
## Packages & Libraries
|
||||
|
||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
||||
* [react-router-dom](https://www.npmjs.com/package/react-router-dom)
|
||||
|
||||
### `npm run eject`
|
||||
## Contributing
|
||||
|
||||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
||||
Pull requests are welcome. Please feel free to submit an issue first to discuss what you would like to change.
|
||||
|
||||
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.
|
||||
The process to start is simple, just make sure you have [Node js](https://nodejs.org/en/) installed in your computer.
|
||||
|
||||
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.
|
||||
First you need to go to project's main directory which contains package.json file
|
||||
|
||||
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.
|
||||
```bash
|
||||
git clone [Repository]
|
||||
|
||||
## Learn More
|
||||
cd [Repository-Directory]
|
||||
|
||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
||||
npm install
|
||||
|
||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
||||
npm start
|
||||
```
|
||||
or
|
||||
```bash
|
||||
git clone [Repository]
|
||||
|
||||
### Code Splitting
|
||||
cd [Repository-Directory]
|
||||
|
||||
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
|
||||
yarn install
|
||||
|
||||
### Analyzing the Bundle Size
|
||||
yarn start
|
||||
```
|
||||
.. happy Coding..!!
|
||||
|
||||
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
|
||||
## Support
|
||||
|
||||
### Advanced Configuration
|
||||
Reach out to me at one of the following places!
|
||||
|
||||
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
|
||||
- Website at <a href="https://izemspot.netlify.com" target="_blank">`izemspot.netlify.com`</a>
|
||||
- Gmail <a href="mailto:zmr.ilyas@gmail.com" target="_blank">`zmr.ilyas@gmail.com`</a>
|
||||
|
||||
### Deployment
|
||||
|
||||
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
|
||||
|
||||
### `npm run build` fails to minify
|
||||
## Final Words
|
||||
|
||||
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
|
||||
If you like the app, please give it a star. It will mean a lot for me :)
|
||||
|
||||
## License
|
||||
|
||||
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
|
||||
- Copyright 2019 © <a href="https://izemspot.netlify.com" target="_blank">IZEMSPOT</a>.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user