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

https://github.com/eltonlazzarin/navedex-frontend-challenge

Internal employee management application - Navers
https://github.com/eltonlazzarin/navedex-frontend-challenge

axios context-api-react eslint frontend-web javascript javascript-applications management-application react react-app react-applications react-hooks react-icons reactjs styled-components

Last synced: about 2 months ago
JSON representation

Internal employee management application - Navers

Awesome Lists containing this project

README

          


Nave.rs logo


Internal employee management application - Navers


GitHub top language

GitHub language count

GitHub last commit

GitHub issues

GitHub


About The Project   |   
Technologies   |   
Getting Started   |   
How To Contribute   |   
License

## 👨🏻‍💻 About the project


Project user interations gif

Navedex is a web application developed with ReactJS and aims to do the internal management of collaborators called Navers. With this application, only authorized users, through login, will be able to create, list, edit and delete the Navers, in addition to being able to view more details of a specific Naver.

## 🚀 Technologies

Technologies that I used to develop this frontend app

- [ReactJS](https://nodejs.org/en)
- [Axios](https://github.com/axios/axios)
- [React-Router-Dom](https://reactrouter.com/web/guides/quick-start)
- [React-Icons](https://github.com/wwayne/react-tooltip)
- [Styled-Components](https://styled-components.com/docs/basics)
- [React-Hooks](https://reactjs.org/docs/hooks-intro.html)
- [Context-API](https://reactjs.org/docs/context.html)
- [VS Code](https://code.visualstudio.com) with [ESLint](https://eslint.org/docs/user-guide/getting-started), [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) and [Prettier RC](https://github.com/prettier/prettier)

## 💻 Getting started

### Requirements

- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)

**Clone the project and access the folder**

```bash
$ git clone https://github.com/eltonlazzarin/navedex-frontend-challenge.git

$ cd navedex-frontend-challenge
```

**Follow the steps below**

```bash
# Install the dependencies
$ yarn

# Run the web app
$ yarn start
```

## 🤔 How to contribute

**Follow the steps below**

```bash
# Clone your fork
$ git clone https://github.com/eltonlazzarin/navedex-frontend-challenge.git

$ cd navedex-frontend-challenge

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature
```

After your pull request is merged, you can delete your branch

## 📝 License

This project is under the MIT license. See the [LICENSE](https://github.com/eltonlazzarin/navedex-frontend-challenge/blob/master/LICENSE) for more information.