Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 3.86 KB

README.md

File metadata and controls

71 lines (56 loc) · 3.86 KB


Facebook clone
Facebook Heroes

A minimal functional clone of Facebook made for the heroes to share their experiences across the universe

Key FeaturesHow To RunFolder structureCreditsRelated

Key Features

  • Create the account with the test credentials.
  • Quick login using Captain America credentials.
  • Hardcode feed
  • Create a new publication
  • Facebook stories

How to run

Run the following commands

yarn install
yarn dev

Folder structure

Name Description
.vscode Contains VS Code specific settings
.github Contains GitHub settings and configurations, including the GitHub Actions workflows
build Contains the distributable (or output) from the react build
node_modules Contains all the npm dependencies
src Contains the source code that will be compiled to the build dir
src/components Components folder organized by features
src/constants Constants that are shared between components
src/docs Static docs files that can be used in the Github documentation readme
src/hooks Hooks used in two or more components
src/pages Pages folder holds the routes and main components
src/styles Styles defines the css used for custom tailwindcss components
src/utils Utils functions shared across the app
package.json File that contains npm dependencies as well as build scripts
tailwind.config.js File that contains tailwind configuration as well as custom tailwind variants
postcss.config.js File that contains postcss configuration
next-env.d.ts Env declaration for NextJS apps
tsconfig.json Config settings for compiling the app code written in TypeScript
.eslintrc Config settings for ESLint code style checking
.eslintignore Config settings for paths to exclude from linting
.gitignore Config settings for paths to exclude from git

Credits

This software uses the following open source packages:

Related

Todo: Update related information