Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ydon96/coindex-api
CoinDex API, your ultimate companion for organizing and categorizing your coin collection effortlessly! Whether you're a numismatist, a collector, or just someone intrigued by coins, CoinDex API is here to simplify the process of identifying and categorizing your coins with just a snap.
https://github.com/ydon96/coindex-api
chai docker eslint expressjs husky mongodb mongoose node prittier rest-api tdd typescript
Last synced: about 1 month ago
JSON representation
CoinDex API, your ultimate companion for organizing and categorizing your coin collection effortlessly! Whether you're a numismatist, a collector, or just someone intrigued by coins, CoinDex API is here to simplify the process of identifying and categorizing your coins with just a snap.
- Host: GitHub
- URL: https://github.com/ydon96/coindex-api
- Owner: yDon96
- License: gpl-3.0
- Created: 2024-03-13T20:46:46.000Z (8 months ago)
- Default Branch: develop
- Last Pushed: 2024-05-29T08:15:09.000Z (6 months ago)
- Last Synced: 2024-10-15T17:31:51.609Z (about 1 month ago)
- Topics: chai, docker, eslint, expressjs, husky, mongodb, mongoose, node, prittier, rest-api, tdd, typescript
- Language: TypeScript
- Homepage:
- Size: 1.28 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CoinDex API 💰
## Table of Contents
1. [Introduction](#introduction)
2. [Motivation](#motivation)
3. [Quick start](#quick-start)
4. [Documentation](#documentation)
5. [Docker](#docker)
6. [Author](#author)
7. [License](#license)
---
## Introduction
Welcome to CoinDex API, your ultimate companion for organizing and categorizing
your coin collection effortlessly! \
Whether you're a numismatist, a collector, or just someone intrigued by coins, CoinDex API is here
to simplify the process of identifying and categorizing your coins with just a snap.
---
## Motivation
While manual cataloging and categorizing served as the foundation
for coin collection management, this process could be extremely **time-consuming, prone to error
and difficult to update**.
---
## Quick Start
### 1. Setup the project
Open your terminal, then run the following command to install dependencies for the project:
```bash
npm install
```
### 2. Set env file
Copy the example [.env file](./.env), and set the needed values:
```bash
cp .env .env.dev
```
> Note: Change 'dev' with 'production' or 'test' for new environment.
### 3. Let's run it!
```bash
npm run dev
```
---
## Documentation
I utilize Swagger for documenting the API endpoints,
providing a clear and interactive way for developers to understand
the functionalities and data models of our system.
Once your project is running, open a web browser and navigate to the Swagger UI URL. This URL is:
```
https:///docs
```
---
## Docker
### 1. Create the image
Open a terminal or command prompt, navigate to the directory
containing your Dockerfile, and run the following command:
```bash
docker build -t .
```
### 2. Start a new container
Once the image is built, you can run it using the following command:
```bash
docker run -it -p 3000:3000 -e [env-var-list]
```
Use _**'-e'**_ to specify all the required environment variable. (See [here](./.env))
---
## Author
[](https://github.com/yDon96)
---
## 📝 License
Copyright © 2024 [Youssef Donadeo](https://github.com/yDon96)
This project is [GNUv3]() licensed.