Internal employee management application - Navers

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

👨🏻‍💻 About the project

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
• Axios
• React-Router-Dom
• React-Icons
• Styled-Components
• React-Hooks
• Context-API
• VS Code with ESLint, EditorConfig and Prettier RC

💻 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

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

$ cd navedex-frontend-challenge

Follow the steps below

# Install the dependencies
$ yarn

# Run the web app
$ yarn start

🤔 How to contribute

Follow the steps below

# 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 for more information.