alexandre-lavoie/mintview

Program for coin examination

mintview

Overview

Mintview is an open-source coin examination/collection software. It was developed with the latest web technologies to give the best UI/UX.

Installing

You can find the latest release of the software under the mintview releases.

License

MIT

Contributing

Before contributing to this repository, please make sure to have a look at the contribution guidelines and the code of conduct.

Overview

The program is developed using TypeScript (which is a type extension of JavaScript). The frontend is developed using the NextJS framework (which is a Server-Side Rendering extension of ReactJS) with heavy use of the Material-UI and Fabric.js packages. The backend will be developed using the Express framework and the Apollo GraphQL framework with the TypeGraphQL package. The desktop application is packaged using Nextron (which is a NextJS implementation of ElectronJS).

Getting Started

Prerequistes

• NodeJS
• npm

Installing

With this software configured, you will want to clone this repository. Inside the repository file, you will want to run the following command:

npm install

Once complete, you should have all the dependencies required for this project.

Running

Web Development Environment

You can start a web development environment using the following command:

npm start

A web development environment should run on http://localhost. This environment is configured with hot reloading and source codes. This allows for quicker production/debugging.

Desktop Development Environment

You can start a desktop development environment using the following command:

npm run start:electron

A development executable should appear on screen. This environment is configured with hot reloading, source codes, and automatic dev tools openning. This allows for quicker production/debugging.

Building

Web Environment (In Development)

You can build the web environment using the following command:

npm run build

This should create a distribution that can be run using a NodeJS server.

Desktop Environment

You can package the code for Windows, Linux, and Mac using the following command:

npm run build:electron

This will generate the packaged files in ./dist. You can also target a specific operating system using any of the following commands:

npm run build:electron:win
npm run build:electron:mac
npm run build:electron:linux

If you have issues building because of canvas.node, run the following commands:

npm update
npm rebuild canvas --update-binary

Documentation

You can find the documentation in the documentation file;

mintview's Issues

Expanding Coin Specifications

We should add more detail fields for coin screenshot.

Adding Filters

There is already a feature that handles filters. This said, we should make a comprehensive UI that makes use of this feature.