This is a Next.js project bootstrapped with create-next-app
.
You can get started with 2 options :
- Via Docker Compose
- Manual Installation
After the app is ready, you can open http://localhost:3000 with your browser to see the result.
/* Build the Docker Image */
docker-compose build
/* Run the Docker containers */
docker-compose up
Before running the application, we need to prepare our local environment first.
You can either use the Node latest LTS or using NVM.
/* Install the npm version registered on this app */
nvm install
/* Use the npm version registered on this app */
nvm use
To optimize performance, this application is using Redis as a temporary cache, allowing it to effectively manage the constraints imposed by the external API, which limits access to 250 calls per day.
If you're on macOS, you can quickly set up Redis with these commands:
/* Install the Redis */
brew install redis
/* Start the Redis */
brew services start redis
For other operating systems, refer to the Redis installation guide available at https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/.
First, install all dependencies:
npm install
Then, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
For a detailed look at each feature, view the screenshots here.