🐉 SI Dragons 🐉

User and Password to access: admin / admin

_{SI Dragons project. Built with ❤︎ by Denis Ladeira}

📌 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
• context-api
• styled-components
• axios
• jest
• testing-library

🚀 Features

• List of all dragons
• See dragon details
• Edit Dragon
• New Dragon add
• Delete dragon
• User authentication with Login page (admin, admin)

👷 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/denismend/si-dragons.git

# In the terminal or prompt(cmd), access the project root;
   $ cd si-dragons
   
# Create .env.local
   - In project root create a .env.local file follow .env.sample with same vars.

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 dev

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 DM Store 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 denismend/si-dragons

# Clone your fork
$ git clone {your-fork-url}
$ cd si-dragons

# 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 2021 📕 License

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