Skip to content

Latest commit

 

History

History
123 lines (88 loc) · 4.25 KB

README.md

File metadata and controls

123 lines (88 loc) · 4.25 KB

🔮 Instamint Project

Instamint is a young startup which allows NFTs & crypto enthusiasts to discover, collect and exchange NFTs and much more!

The main objective of the project is to develop a platform that complies with the specifications detailed in the call for tenders, focusing on innovation, sustainability and the integration of Web3 technologies. It aims to offer an exceptional user experience through an intuitive and engaging user interface, while strictly complying with security and accessibility standards and legal frameworks, particularly with regard to data protection. The project will also seek to assess and minimise its ecological footprint, affirming its commitment to sustainable development.

🐐 Contributors

🔨 Setup

🐳 From Docker environment

  • Make sure you have Docker installed on your machine.

  • Setup ur .env file with the following variables -> See example.

  • To run this project clone this repository and run it locally using docker commands.

    • 🚀 Production:

      Start the project:

      make prod-up

      Stop the project:

      make prod-down

    • ⚙️ Development:

      Start the project:

      make dev-up

      Stop the project:

      make dev-down

🔑 From the local environment

  • You need to have PNPM installed, if not you can install it by following the instructions.

  • Setup ur .env file with the following variables -> See example.

  • Install PostgreSQL & Redis on your local machine.

  • Install the dependencies by running pnpm install at root.

  • Start the development server by running the following commands at root:

    🖥️ Front - Instamint Webapp:
    pnpm run dev:webapp
    🖥️ Back - Instamint Business:
    pnpm run dev:business
    🖥️ Back - Instamint Files:
    pnpm run dev:files

🔗 Access the project:

⭐️ Tech Stack

  • Client: Next.js & TypeScript
  • Server: HonoJS & TypeScript
  • Database: PostgreSQL
  • Mockup: Figma
  • CI/CD: Github Actions
  • Testing: Jest
  • Deployment: Vercel
  • Monitoring: Sentry
  • Containerization: Docker

💡 Other Tools

♾️ Utils

  • In the project directory, you can test API endpoints with Bruno, after installing it and targeting the directory where you cloned the project, you will have access to the various endpoints preconfigured on the correct urls and ports, as well as the body, params, etc.

📝 License

No part of this software may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the author. For permission requests, write to the author at the email provided in the contact details.

For more details, see the LICENSE.md file.