Next.js (TypeScript) solution for the CatWiki Challenge on devChallenges.
Live demo available at: https://catwiki-three.vercel.app/
This project was built to complete all the user stories listed or described by the challenge itself. Hence in this project, a user can:
- Search for cat breeds and select a breed of my choice
- See the most popular searched cat breeds summary on the homepage
- See the breed details including description, temperament, origin, life span, adaptability, affection level, child-friendly, grooming, intelligence, health issues, social needs, stranger friendly
- See more photo of the breed (to be done.)
- On mobile, when a user selects the search option, a modal for breed search should pop up
- To get this project files locally on your machine, you can clone this repository by running the following command on your terminal or command line:
git clone https://github.com/cvrlnolan/catwiki- Next, you need to setup the .env file found in the root with the appropriate API Keys & credentials from the following service providers:
-
Install all the dependency packages found in the
package.jsonfile by runningyarn installornpm installfrom the project root directory. -
Initialize tailwindcss by running
npx tailwindcss init -pto generate thetailwind.config.jsandpostcss.config.jsconfiguration files. -
To start the development server of the application, run
npm run devoryarn dev. This should log some start-up application information & display the development server url:http://localhost:3000. Visit http://localhost:3000 to view your application.
This application was built reflecting the MVC architecture and the main dependencies(all found in the package.json) of the application are organised as so:
- Front-end User Interface(UI): Tailwind CSS
- Backend Integration: Next.js API
Other important services & dependency libraries of the application include:
- axios: An http client to fetch urls and make api calls or requests within the application.
- swr: To fetch and revalidate data on the client-side of the application while keeping the UI reactive.
The application is organized from the root(.) as follows:
./page/folder(integrated by NextJS) contains the UI Views for the application with the exception of the ./page/api/* sub-folder../components/folder contains coded UI layouts to be used through out the application../styles/folder(integrated by NextJS) contains the global style of the application in which Tailwindcss presets have been defined. The global stylesheet is accessible by all components../public/folder(integrated by NextJS) contains global files to be shared through the application. You can store static images here.
Absolute imports to any of these folders through the application are configured in the tsconfig.json file in the root.
You may eventually want to deploy a live version of your app in a future instance. Vercel platform is suitably built fo the deployment of NextJS application and more as they have an integrated environment to deploy directly from your own Github Repository.
If any worries, bugs or problem arises in the future, you can create an issue, contribute or contact me via:
