Giter VIP home page Giter VIP logo

ahujamoh.github.io

Netlify Status

A personal website of Mohit Ahuja( forked from Richard's Nguyen and this is its source code. This website is written in Gatsby, React, Typescript and Styled-components.

Notes: Richard had open-sourced his website to share the structure, the configurations, and how he organizes all of those things. He hopes that it could help some people are having troubles in writing their very first sites (in Gatsby and stuff). However, the website is highly customized to match his desires, so it could be a little frustrating to modify the codes to your version. But he will be happy if you do so. Not only will you improve your coding skills but also respect him and what he's doing.

Usage

  1. Clone the repository

      git clone https://github.com/richardnguyen99/richardnguyen99.github.io
    
      # or
      # git clone  https://github.com/ahujamoh/ahujamoh.github.io
  2. Know the structure

    Before getting your hands on, Richard would like to tell you more about how he organizes stuff. Richard only explains his stuff. Others can be seen at gatsby-starter-default

    • In the root directory:

      • .editorconfig: a set of consistent formatting styles for the whole project.

      • .eslintrc.js: a tool to check all Javascript errors and fix them.

      • .eslintignore: a list of files and folders that ESLint will ignore.

      • .huskyrc: a pre-commit hook script to prevent bad commits.

      • .lintstagedrc: a linter linting files on staged.

      • .stylelintrc: a tool like ESLint but for CSS.

      • tsconfig.json: a set of rules and configurations for Typescript compiler.

    • In the source directory:

      • @types/: customized type definitions.

      • components/: reusable components.

      • _contexts/__: React context (theme, languagues, etc.).

      • hooks/: customized React hooks.

      • **images/**: images for displaying content of the website.

      • **pages/**: contents will be displayed on the website

      • **utils/**: sets of tools to help in development process.

      • **types.ts**: list of types and interfaces.

  3. Play around:

    Install dependencies:

      yarn install

    Setup

       yarn install dotenv
       # setup .env in root folder for GATSBY_GITHUB_KEY

    Development:

      yarn develop

    Production:

      yarn build
  4. Deploy:

Currently, this website is being deployed to Netlify (free for static website), so the script yarn deploy won't work properly (You can try if you still want to).

Liability declartion

This is an open source code and you are responsible for securing your website, the authors are not responsible for your usage of the source code.

Authors

Contribution & Contact

If you found any problems or issues, please feel free to open a pull request to fix that. Mohit would be happy if there were someone improving the website with him. If a pull request is unnecessary, you contact him with:

Mohit Ahuja's Projects

Mohit Ahuja doesnโ€™t have any public repositories yet.

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.