moobile

The best smartphone marketplace in the world!
See source code »

Report a bug · Request a feature

Table of contents

1. About the project
   • Built with
2. Getting started
   • Prerequisites
   • Installation
   • Running the application
   • Linting
   • Building for production
3. Contributing
4. Versioning
5. License

🔉 About the project

Either you are buying a new phone or just taking a little peek, this simple marketplace is all you need! We have over 100+ smartphones on sale and the best prices out there.

🔧 Built with

Here are some of the tools and frameworks that make moobile so awesome:

• React: a JavaScript library for building user interfaces. React is the esqueleton, muscles and nerves of moobile's web application. On this front, Create React App offers a modern build setup with zero configuration.
• Bulma: a modern CSS framework. I decided to build my own atomic components using Bulma's CSS utilities instead of using a pre-built components library because I think the point of this project is to prove myself worth.
• Prettier: an opinionated code formatter with great flexibility. Here it is configured with a few custom options.
• Husky: Git hooks. One pre-commit hook is in place to make sure all commits are correctly formatted.

👨‍💻 Getting started

To get a local copy up and running follow these simple example steps.

📝 Prerequisites

You only need Node.js and npm to be able to run this project.

🔌 Installation

Clone the repo using git clone https://github.com/d0vi/moobile.git.

Install the dependencies via npm with npm install.

🏃‍♂️ Running the application

This will launch the app on the port 3000:

npm start

🕵️ Linting

ESLint will analyze the code to find any problem:

npm run lint

🎁 Building for production

npm run build

🔝 Contributing

Any contributions are greatly appreciated.

1. Fork the project.

2. Create your feature branch.

   git switch -c feature/something-amazing

3. Commit your changes.

   git commit -m "Add a new amazing feature"

4. Push your branch to your remote fork.

   git push origin feature/something-amazing

5. Open a pull request.

📦 Versioning

We use SemVer for versioning. For the versions available, see the releases section on GitHub.

⚖️ License

Distributed under the MIT License. See LICENSE for more information.