Skip to content

Michelprogram/magic-scanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Scan cards of Magic the gathering

Backend api using golang, with api Scryfall and OCR vision from google cloud.


Table of Contents
  1. 🧭 About The Project
  2. 📋 Getting Started
  3. 💾 Usage
  4. 🔗 Contributing
  5. 📰 License
  6. 📫 Contact
  7. ⛱️ Acknowledgments

🧭 About The Project

🏗️ Built With

List of technologies / frameworks used during the project.

  • Heroku Badge
  • Google cloud Badge
  • Go Badge
  • React Badge
  • Tailwind Badge
  • 🐋 Docker

⬆️

📋 Getting Started

The concept of this project is to scan magic card from your phone and save it into notion.

🗺️ Prerequisites

You need node 18 and Go 1.19 for running this project.

Get Nodejs at this url : https://nodejs.org/en/download/

Get Golang at this url : https://go.dev/doc/install

Also you need to create .env at the backend/server folder project :

NOTION_TOKEN=key
VISION_TOKEN=key

This tokens could be found here for Notion Token and here for OCR Vision.

The backend is hosted on heroku and the frontend on vercel. You can find the notion here

⬆️

💾 Usage

Run the backend :

$bash : cd frontend
$bash : pnpm run dev:backend

The frontend can be run with http or https, in local to acces webcam need https :

$bash : pnpm run dev:http #http
$bash : pnpm run dev:https #https

⬆️

🔗 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

⬆️

📰 License

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

⬆️

📫 Contact

Reach me at : gauron.dorian.pro@gmail.com.

Project Link: https://github.com/Michelprogram/magic-scanner.git

⬆️

⛱️ Acknowledgments

This space is a list to resources i found helpful and would like to give credit to.

⬆️

Template inspired by othneildrew