keycloak-reg-ui/README.md

85 lines
1.9 KiB
Markdown
Raw Normal View History

2019-07-24 22:21:08 +00:00
# Logster - login/register-page-app
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
> Simple login/register-page-app created with React js.
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
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.
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## 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)
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Functionalities
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
* Login with username and password
* Create an account
* Reset password
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Technologies
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
* React js
* HTML5
* CSS3
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Live App
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
To view and test the app you can visit this [link](https://logsterapp.netlify.com/).
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Packages & Libraries
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
* [react-router-dom](https://www.npmjs.com/package/react-router-dom)
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Contributing
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
Pull requests are welcome. Please feel free to submit an issue first to discuss what you would like to change.
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
The process to start is simple, just make sure you have [Node js](https://nodejs.org/en/) installed in your computer.
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
First you need to go to project's main directory which contains package.json file
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
```bash
git clone [Repository]
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
cd [Repository-Directory]
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
npm install
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
npm start
```
or
```bash
git clone [Repository]
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
cd [Repository-Directory]
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
yarn install
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
yarn start
```
.. happy Coding..!!
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Support
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
Reach out to me at one of the following places!
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
- 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>
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
## Final Words
2019-07-22 14:43:45 +00:00
2019-07-24 22:21:08 +00:00
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>.