https://github.com/mexaar/mexar.io
https://github.com/mexaar/mexar.io
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mexaar/mexar.io
- Owner: MeXaaR
- Created: 2024-10-07T11:14:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T19:02:45.000Z (over 1 year ago)
- Last Synced: 2024-11-17T20:18:09.514Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://mexar-io.vercel.app
- Size: 360 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mexar.io: Free Tools App
A Next.js application offering a suite of free tools for developers, designers, and everyday users. The app is currently under development, and we welcome contributions from the community to expand our toolset.
## 🚀 Features
- A growing collection of free, easy-to-use tools.
- Consistent and intuitive user interface.
- Modular architecture for seamless addition of new tools.
- Dark mode support for comfortable usage in low-light environments.
## 🛠️ Getting Started
Follow these instructions to set up the project locally for development and testing purposes.
### 📋 Prerequisites
- Node.js (version 14.x or higher)
- Yarn or npm (package managers)
### 🔧 Installation
1. Clone the repository
```bash
git clone https://github.com/yourusername/your-repo-name.git
```
2. Navigate to the project directory
```bash
cd your-repo-name
```
3. Install dependencies
Using Yarn:
```bash
yarn install
```
Or using npm:
```bash
npm install
```
4. Run the development server
Using Yarn:
```bash
yarn dev
```
Or using npm:
```bash
npm run dev
```
5. Open the app in your browser
Visit `http://localhost:3000` to view the application.
## ⚙️ Configuration
### Environment Variables
Create a `.env.local` file in the root directory to set up any necessary environment variables. Refer to `.env.example` for a template.
## 📚 Usage
Explore the available tools directly from the homepage or the navigation menu. Each tool is designed with usability in mind and includes instructions or placeholders to guide you.
## 🤝 Contributing
We appreciate contributions of all kinds! Whether you're fixing bugs, adding new features, or improving documentation, your help is welcome.
### 🧰 Adding a New Tool
1. Fork the repository
Click on the 'Fork' button on the repository page to create a copy under your GitHub account.
2. Create a new branch
```bash
git checkout -b feature/your-tool-name
```
3. Navigate to the templates folder
The templates folder contains starter code and guidelines for adding new tools.
```bash
cd templates
```
4. Copy the template
Duplicate the `TemplateTool` folder and rename it to your tool's name (e.g., `MyNewTool`).
Update the component and file names accordingly.
5. Implement your tool
Follow the coding standards and conventions used in the project.
Ensure your tool integrates well with the existing layout and styling.
6. Update navigation and routing
Add your tool to the navigation menu by updating the relevant components or configuration files.
Ensure that routing to your tool's page is correctly set up.
7. Test your tool
Verify that your tool functions as intended.
Fix any bugs or issues that arise during testing.
8. Commit and push your changes
```bash
git add .
git commit -m "Add new tool: Your Tool Name"
git push origin feature/your-tool-name
```
9. Submit a pull request
Go to your forked repository on GitHub.
Click on 'Compare & pull request' and submit your PR to the main branch.
Provide a clear and descriptive title and description for your PR.
## 📝 Guidelines
### Code Style
- Maintain consistency with the existing codebase.
- Use meaningful variable and function names.
- Include comments where necessary for clarity.
### Dependencies
- Minimize the addition of new dependencies.
- If a new dependency is required, ensure it is well-justified and widely supported.
### Documentation
- Update the README or create a separate documentation file for your tool if needed.
- Include usage instructions and any important notes.
### Testing
- Write unit tests for your tool if applicable.
- Ensure existing tests pass before submitting your PR.
## 📢 Code of Conduct
By participating in this project, you agree to abide by the Code of Conduct.
## 🐛 Reporting Issues
If you encounter any bugs or have feature requests, please open an issue on GitHub.
## 📄 License
This project is licensed under the terms of the MIT license. See the LICENSE file for details.
## 🙏 Acknowledgments
- Next.js for providing a robust framework for building web applications.
- Contributors who have helped improve the app through code, documentation, and feedback.
## 📞 Contact
For any questions or suggestions, feel free to reach out:
- Email: contact@mexar.fr
- GitHub: @MeXaaR