carollyb/natgeo-front

NatGeo - Webpage

NatGeo helps organizing magazine issues digital files, allowing creation, deletion and searching magazine issues by multiple parameters
🚧 In progress 🚧

This project was created as a study case to apply some topics I am interested in studying, such as:

• AWS S3 Bucket and aws-sdk
• Next
• Accessibility

Check #development section to see a full list of design patterns, technologies and libraries used

Contents

• Running the project
  • Locally
• Development
  • Technologies
  • State Management
    • S3 Bucket
  • API
  • Libraries & Frameworks
• Backend
• Wishlist

Running the project

Locally

Have Node (latest stable version) installed on your machine.

Clone the repo:

git clone https://github.com/carollyb/natgeo-front.git

Go to directory:

cd natgeo-front

Install projects dependencies

npm i

Run

npm run dev

Development

Technologies

In progress

State Management

Zustand - global states

S3 Bucket

Storing images and files to S3 bucket via aws-sdk

API

Domain Folder

Libraries & Frameworks

React with Typescript, Next, AWS SDK, ChakraUI, Zustand

Backend

API

Wishlist

• Upload issues via aws-sdk through an authenticated form page
• Display issues files with react-pdf and issues covers from s3 bucket. PDF files also stored in s3 bucket
• Typescript paths alias
• Accessibility with HeadlessUI