mf-custom-example

This is a simple Example of Micro frontend using module fedetion from webpack.

📌 Table of Contents

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

💻 Technologies

This project was made using the follow technologies:

• Webpack Module Federation
• Typescript
• React
• styled-components
• jest
• testing-library

👷 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/mf-custom-example.git

# In the terminal or prompt(cmd), access the project root;
   $ cd mf-custom-example

obs. Make sure you have Node and npm installed in your computer. You can use yarn instead npm.

💻 Run Project

# Install Dependencies
$ npm install
or
$ yarn

# Run Aplication
$ npm start
or
$ yarn start

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

🧪 Run Tests

Will be implemented..

🐛 Issues

Feel free to file a new issue with a respective title and description on the the Todo With Tests 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/mf-custom-example

# Clone your fork
$ git clone {your-fork-url}
$ cd mf-custom-example

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

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