Prerequisites • How To Use • Credits • Contributing • Support • License

Click here to submit your API

Built with

Prerequisites

Before starting to use the software make sure you have docker installed.

How To Use

Clone the repository

git clone https://github.com/exifly/ApiVault

Set .env file

Inside root repository folder rename .env.dev file

cat .env.dev > .env

Inside /frontend folder rename .env.sample file

cd frontend
cat .env.dev > .env

Same action inside /backend folder

cd backend
cat .env.dev > .env

Client/Server side using Docker

# Go into the root folder
cd ApiVault

# Run docker
docker-compose up

Important note:

On first docker-compose launch, your terminal could tell you:

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

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 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
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 once before making changes!

How to Contribute 🤔

Look at the existing Issues or create a new issue!
Fork the Repo 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 (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

Contributors ✨

Thanks go to these wonderful people ✨:

_gdjohn4s 🥳	_{Flavio Adamo} 🥳	_NirajD10 🥳	_kiabq 🥳	_{Atharva Salitri} 🥳	_Caick 🥳	_{Avishkar Kotkar} 🥳	_{James Francis} 🥳	_{MOHD NEHAL} 🥳	_{Tarun Samanta} 🥳
_{Rohit Gurav} 🥳	_Badrnyali 🥳	_bytemore 🥳	_{Hassan Tanveer} 🥳	_cyberGHostJs 🥳	_et-c 🥳	_{Domenico Tenace} 🥳