Git Product home page Git Product logo

jahir.dev's Introduction

GitHub Sponsor

Website preview

Stack

Project Structure

.
|____config
|____content
|____public
|____scripts
|____src
| |____actions
| |____app
| |____assets
| |____components
| | |____core
| | |____molecules
| | |____og
| | |____views
| | |____icons.ts
| |____data
| |____hooks
| |____lib
| |____providers
| |____styles
| |____types
| |____utils
  • config/* - Includes all the custom configuration for MDX, velite and Next.js
  • content/* - MDX blog posts and the content for the donate pages
  • public/* - Static assets including images, fonts, audios, files, etc.
  • scripts/* - Utilities to setup the project
  • src/app/* - Every page and API route in the website. Uses the new App Router from Next.js 13.+
  • src/assets/* - Fonts and static images used in different components
  • src/components/core/* - The simplest components. Most of them are stateless
  • src/components/molecules/* - The main blocks for the website: toolbar, footer, main layout, back-to-top button and social links
  • src/components/og/* - The code that powers dynamic open-graph images generation
  • src/components/views/* - More complex components to build the different pages of my website. (They're here to keep src/app/ as clean as possible)
  • src/components/icons.ts - SVG icon paths. Icons come from Material Design Icons and Lucide
  • src/data/* - JSON files containing data for projects and the uses page
  • src/hooks/* - A couple hooks used throughout the app
  • src/lib/* - Short for "library", a collection of helpful utilities or code for external services
  • src/providers/* - React Contexts for storing the current theme and blog post reactions
  • src/styles/* - Global styles with scss. Mostly use tailwind classes
  • src/types/* - Some types definitions
  • src/utils/* - More utilities functions but less complex than the ones in lib

Running Locally

This application requires Node.js v18.18+.

  1. Clone the project, install dependencies and run initial setup

    git clone https://github.com/jahirfiquitiva/jahir.dev.git
    cd jahir.dev
    yarn
    yarn setup # You can skip this if you're contributing to this repository. It removes all of my personal content and files
  2. Create a .env file similar to .env.example.

  3. (Optional) This project uses a postgres database to store the views and reactions count.

    CREATE TABLE counters (
      slug VARCHAR(255) PRIMARY KEY NOT NULL,
      views INTEGER NOT NULL DEFAULT 0,
      likes INTEGER NOT NULL DEFAULT 0,
      loves INTEGER NOT NULL DEFAULT 0,
      awards INTEGER NOT NULL DEFAULT 0,
      bookmarks INTEGER NOT NULL DEFAULT 0
    );
  4. Run the project locally:

    yarn dev
Note

Some things might be broken or not found because the yarn setup script will remove many files. Please double check the code and implementations.

Cloning / Forking

Please review the license, do not copy it directly, remove all of my personal content and files (resume, blog posts, images, etc.) by running yarn setup and please change the styling and colors to match your personal brand. You are free to use this code as inspiration or learning reference but this is not really intended to be a template.

Additional changes

Make sure to set the IS_TEMPLATE environment variable to false. Otherwise, the colors in the website might be inverted. (See src/styles/globals.scss)

Previous versions

All the previous versions of this website can be found at jahirfiquitiva/prev-websites

jahir.dev's People

Contributors

jahirfiquitiva avatar erikstreller avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.