Challenge

List Teams and Team's members

📌 Table of Contents

• Technologies
• Features
• How to Run
• Found a bug? Missing a specific feature?
• Contributing
• License

💻 Technologies

This project was made using the follow technologies:

• Typescript
• React
• NextJs
• React-Query
• styled-components
• axios
• jest
• testing-library

🚀 Features

• List of all teams (cached by react-query)
• List of all team's members (get in server side, cached with static path, @see Nextjs SSG)
• Filter data (Using a custom debounce hook)

👷 How to run

# Clone the project on your computer via Download (option Code -> Download ZIP)
    - If you want to do it with Git, make sure you have Git installed,
      follow the link https://git-scm.com/
    - then run the command in terminal:
        $ git clone https://github.com/denisfloyd/challenge-users-teams.git

# In the terminal or prompt(cmd), access the project root;
   $ cd challenge-users-teams

obs. Make sure you have Node 17 (stable) and npm installed in your computer. You can use yarn instead npm. We recommend to use stable version.

💻 Run Project

# Install Dependencies
$ yarn

# Run Aplication (Dev mode)
$ yarn dev

# Run Aplication (Build mode)
$ yarn build
$ yarn start

Go to http://localhost:3000/ to see the result.

🧪 Run Tests

# Install dependencies if you didn't
# Run tests
$ yarn test

# Run test coverage
$ yarn test:coverage

🐛 Issues

Feel free to file a new issue with a respective title and description on the the ecore-users-teams repository. If you already found a solution to your problem, i would love to review your pull request!

🎉 Contributing

There are many forms to contribute with the project, first of all you can give this github repo a Star.

If you want do help with the code follow the steps bellow

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork denisfloyd/challenge-users-teams

# Clone your fork
$ git clone {your-fork-url}
$ cd challenge-users-teams

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

# Make the commit with your changes
$ git commit -m 'Feat: {feature-name}'

# Send the code to your remote branch
$ git push origin {branch-name}

📕 License

Released in 2022 📕 License

Made with love by Denis Ladeira 🚀. This project is under the MIT license.