Coder Social home page Coder Social logo

jimmeex / my_website Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 5.23 MB

My Portfolio Website

Home Page: https://jameslin.me

License: GNU General Public License v3.0

Dockerfile 0.40% HTML 0.85% SCSS 29.46% TypeScript 69.28%
reactjs aws docker website portfolio react typescript

my_website's Introduction

My Portfolio Website

Made open-source for fellow programmers to pry into to learn. May be helpful for beginners looking into frontend web-development. I am regularly making updates as I learn more tools and best practices. Have fun :).

Tech-stack

This website is currently hosted as a static website.

  • React.js - Frontend 'framework' for this website! The project was initialised using create-react-app.
  • TypeScript - Builds types into JavaScript.
  • Sass - Superset of CSS (adds extra useful features).

Notable Packages

Dev Tools

  • Docker - Sets up the dev environment effortlessly (and a lot more!).
  • Eslint - Enforce 'good' JavaScript practices & consistent code style.
  • Prettier - Similar to Eslint.

Prod Tools

I used AWS to host this website. Some of its tools involve:

Running the Code

If you want to run the website locally in a non-development environment, you can simply run:

docker run -p 3000:3000 -i jimmeex/my_website

2. Via the Dockerfile

If you want to play around with the website and make changes in the code, you can:

  1. Download the code locally

    git clone [email protected]:JimmeeX/my_website.git

  2. Navigate to the directory

    cd my_website

  3. Run the development environment (requires Docker & docker-compose)

    docker-compose up --build

3. Via npm

If you want to play around with the website and make changes in the code, you can:

  1. Download the code locally

    git clone [email protected]:JimmeeX/my_website.git

  2. Navigate to the directory

    cd my_website

  3. Install packages and dependencies locally

    yarn

  4. Run a live server under a development environment

    yarn start

After following the steps in any of the 3 methods above, the website should be live and accessible at http://localhost:3000/

my_website's People

Contributors

jimmeex avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

my_website's Issues

Refactor

Task List

  • Update JavaScript Packages
  • ESLint to Enforce Coding Style

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.