Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jakazzy/authapp


https://github.com/jakazzy/authapp

Last synced: 17 days ago
JSON representation

Awesome Lists containing this project

README

        

# Authapp
> This is a simple application to login and sign up into an admin dashboard, created with react.

## Table of contents
* [General info](#general-info)
* [Screenshots](#screenshots)
* [Technologies](#technologies)
* [Setup](#setup)
* [Features](#features)
* [Status](#status)
* [Inspiration](#inspiration)
* [Contact](#contact)

## General info
A simple application auth application built with react.
View application here. [Auth app](https://authappchallenge.netlify.com/)

## Screenshots
login screen
login screen
login screen

## Technologies
* React - version ^16.8.6
* React-dom - version ^16.8.6
* react-router-dom - version ^5.0.1
* react-scripts - version ^3.0.1
* formik - version ^1.5.7
* yup - version ^0.27.0

## Setup
```
# Clone this repository
$ git clone https://github.com/jakazzy/authapp

# Go into the repository
$ cd authapp

# Open project in IDE or Text editor
```
In the project directory, you can run:

### `npm start` or `yarn start`

Runs the app in the development mode.

Open [http://localhost:3000](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.

### `npm test`

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.

### `npm run build`

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!

## Code Examples
Show examples of usage:
`put-your-code-here`

## Features
List of features ready and TODOs for future development
* Sign in
* Sign up
* View dashboard
* View home page and logout

## Status
Project is: _in progress_

## Inspiration
Projects done and submitted as JF-1 challenge for Kudobuzz.