Website · Quick start

The API of HiberFile.

🚀 Quick start

Prerequisites

• Node.js and npm installed on your computer.

Getting Started

1. Clone the repository:

   git clone https://github.com/hiberfile/hiberapi.git

2. Install dependancies:

   cd hiberapi && npm install

3. Generate and download your AWS credentials. You must have a file credentials in the .aws directory.

   You can follow this official guide.

4. Create the .env file and edit it (here is an example):

   cp .env.example .env
   nano .env

   Note that you can use your favorite editor instead of nano, like vi or mcedit.

5. Use your own endpoint of the S3.

   nano src/utils/s3.ts

   Then, on the 19th line, edit the endpoint.

6. Launch the dev server (optional):

   npm run dev

7. Deploy the server:

   npm run build && npm run start

🤝 Contributing

If you are interested in helping contribute to HiberFile, feel free to open a pull request.

Code Contributors

📝 License

© 2021 HiberFile Team

This project is GPL-3.0 licensed.