Welcome to the Falkor API, a custom-built API using the Adonis framework and TypeScript. This API is designed for personal use, providing a range of functionalities to enhance productivity and streamline tasks.

• Built with Adonis: Leverages the robustness of the Adonis framework.
• TypeScript Support: Ensures type safety and enhances development experience.
• Customizable Endpoints: Tailored endpoints to suit varied personal requirements.
• Security: Implements industry-standard security protocols.
• Efficient Data Handling: Optimized for fast and reliable data processing.

To start using the Falkor API, follow these steps:

git clone https://github.com/tyree-z/falkor.git
cd falkor

Follow the instructions to set up your local development environment for Falkor. Once the setup is complete, you need to configure environment variables. These variables are crucial for the proper functioning of Falkor.

Here's an example of the necessary environment variables:

PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY= # 32 characters
APP_NAME=Falkor
DRIVE_DISK=local
CACHE_VIEWS=false
SESSION_DRIVER=redis
REDIS_CONNECTION=redis
REDIS_HOST= # Redis host
REDIS_PORT=6379
REDIS_PASSWORD= # Redis password

1. PORT: Defines the port number on which your AdonisJS server will listen. Default is 3333.
2. HOST: The host address for your server. Typically set to 0.0.0.0 to accept requests from all IPs.
3. NODE_ENV: Determines the environment in which your Node.js application is running (development, production, test).
4. APP_KEY: A unique key used by AdonisJS for encryption and hashing. Generate it using adonis key:generate.
5. APP_NAME: The name of your application. Used primarily for display purposes.
6. DRIVE_DISK: Specifies the storage disk used by the application, e.g., local, s3 for AWS S3.
7. CACHE_VIEWS: Boolean to enable or disable view caching. Set to true to enable caching.
8. SESSION_DRIVER: Determines the session driver to be used, e.g., cookie, file, redis.
9. REDIS_CONNECTION: Defines the Redis connection used. Typically set to redis.
10. REDIS_HOST: Host address for the Redis server. Replace with the actual host IP or URL.
11. REDIS_PORT: Port number for the Redis server. Default is 6379.
12. REDIS_PASSWORD: Password for connecting to Redis, if applicable. Replace with the actual password.

Remember to replace these values with your specific configurations and never share sensitive data such as your APP_KEY publicly.

npm install

Run in Development Mode (Hot Reloads On File Changes)

node ace serve --watch

Run in Production Mode

node ace build --production

cd build
node server.js

For more detailed documentation on the API endpoints and their functionalities, refer to API Documentation.

We welcome contributions to Falkor API. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

This project is licensed under the MIT License - see the LICENSE file for details.