Prerequisites •
How To Use •
Credits •
Contributing •
Support •
License
# Built with
[](https://nuxt.com/)
[](https://vuejs.org/)
[](https://www.djangoproject.com/start/overview/)
# Prerequisites
Before starting to use the software make sure you have docker installed.
# How To Use
## Clone the repository
```bash
git clone https://github.com/exifly/ApiVault
```
## Set .env file
Inside root repository folder rename .env.dev file
```bash
cat .env.dev > .env
```
Inside /frontend folder rename .env.sample file
```bash
cd frontend
cat .env.dev > .env
```
Same action inside /backend folder
```bash
cd backend
cat .env.dev > .env
```
## Client/Server side using Docker
```bash
# Go into the root folder
cd ApiVault
# Run docker
docker-compose up
```
## Important note:
On first docker-compose launch, your terminal could tell you:
```bash
database_dev | 2023-05-26 13:38:01.598 UTC [83] ERROR: relation "vault_api" does not exist at character 232
database_dev | 2023-05-26 13:38:01.598 UTC [83] STATEMENT: SELECT "vault_api"."id", "vault_api"."name", "vault_api"."auth", "vault_api"."category_id", "vault_api"."cors", "vault_api"."description", "vault_api"."https", "vault_api"."url", "vault_api"."view_count", "vault_api"."source" FROM "vault_api" LIMIT 21
database_dev | 2023-05-26 13:38:01.624 UTC [83] ERROR: relation "vault_api" does not exist at character 232
```
or
```bash
server_dev | File "/usr/local/lib/python3.8/dist-packages/psycopg2/__init__.py", line 122, in connect
server_dev | conn = _connect(dsn, connection_factory=connection_factory, **kwasync)
server_dev | psycopg2.OperationalError: connection to server at "database" (172.20.0.2), port 5432 failed: Connection refused
server_dev | Is the server running on that host and accepting TCP/IP connections?
```
To fix those erros just stop it and relaunch `docker-compose up`
**Note**:
Please open an [Issue](https://github.com/Exifly/ApiVault/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) if you see docker errors! (You can try fix on your own if you want)
Now just go on **localhost:3000** on your browser.
### Done
# Credits
This software uses the following open source packages:
### Tools 🔧
- [GSAP](https://greensock.com/gsap/)
- [public-apis](https://github.com/public-apis/public-apis) (a portion of our data)
# Contributing
If you've ever wanted to contribute to open source, and a great cause, now is your chance!
> When contributing to this repository, please first discuss the change you wish to make via issues with the authors of this repository before making a change.
> Make sure to go through the **[CODE OF CONDUCT](https://github.com/Exifly/ApiVault/blob/main/CODE_OF_CONDUCT.md)** once before making changes!
### How to Contribute 🤔
- Look at the existing [**Issues**](https://github.com/Exifly/ApiVault/issues) or [**create a new issue**](https://github.com/Exifly/ApiVault/issues/new/choose)!
- [**Fork the Repo**](https://github.com/Exifly/ApiVault/fork) to make changes.
- Then, create a branch for any issue that you are working on.
- Finally, implement your changes by committing your work.
- Create a **[Pull Request](https://github.com/Exifly/ApiVault/compare)** (_PR_), which will be promptly reviewed and given suggestions for improvements by the community.
- Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
> For more detailed instructions ---> **[CONTRIBUTING.md](https://github.com/Exifly/ApiVault/blob/main/CONTRIBUTING.md)**
## Contributors ✨
Thanks go to these wonderful people ✨:
## Support
Feel free to open issues and pull requests and **Don't forget to leave a star ⭐**
If you want to support us with a coffee, that's how to do it! ❤️
[](https://ko-fi.com/T6T0LL2YG)
## License
ApiVault is licensed under the terms of **CC BY-NC-ND 4.0**. Check out [LICENSE](https://github.com/Exifly/ApiVault/blob/main/LICENSE) for details.
> [exifly.it](https://exifly.it) ·
> GitHub [@exifly](https://github.com/Exifly)
