https://github.com/motapinto/marketplace-graphql-api
Marketplace GraphQL API using Type-GraphQL and ArangoDB. Check the API documentation below!
https://github.com/motapinto/marketplace-graphql-api
api api-documentation arangodb graphql graphql-api mocha mocha-tests node type-graphql typescript
Last synced: about 2 months ago
JSON representation
Marketplace GraphQL API using Type-GraphQL and ArangoDB. Check the API documentation below!
- Host: GitHub
- URL: https://github.com/motapinto/marketplace-graphql-api
- Owner: motapinto
- Created: 2021-01-26T11:48:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-17T16:39:02.000Z (about 5 years ago)
- Last Synced: 2025-06-16T00:18:39.203Z (12 months ago)
- Topics: api, api-documentation, arangodb, graphql, graphql-api, mocha, mocha-tests, node, type-graphql, typescript
- Language: TypeScript
- Homepage: https://motapinto.github.io/marketplace-graphql-api/api/doc/
- Size: 1.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API usage instructions
## Documentation
Visit the API schema [here](https://motapinto.github.io/marketplace-graphql-api/api/doc/)!
## Info
To edit the database configuration change the .env file in /api/.env with the following structure:
> DATABASE_NAME=farmland\
> DATABASE_USER=root\
> DATABASE_PASS=rootpassword\
> DATABASE_URL=http://arangodb:8529
**Note:** This is the default configuration
## How to use
* Run arangodb
* docker-compose up -d arangodb
* cd api && npm install
* npm run build
* npm run populate
* Visit http://localhost:8529 and enter credentials (optional)
* Run API
* npm start (in /api/)
* Visit http://localhost:5000/graphql and enter valid queries
## Testing
Steps to reproduce tests:
1. Run arangodb (docker-compose up -d arangodb)
2. Run tests (npm run test:dev in /api/)
**Disclaimer**: This API does not have extensive validation and was developed as a learning project