Skip to content

Instantly share code, notes, and snippets.

@hamzaPixl
Created August 15, 2021 17:32
Show Gist options
  • Select an option

  • Save hamzaPixl/524d5dbbae247afc85fb52c553f83722 to your computer and use it in GitHub Desktop.

Select an option

Save hamzaPixl/524d5dbbae247afc85fb52c553f83722 to your computer and use it in GitHub Desktop.
Example readme for personnal webiste, can be used for other projects

Contributors Forks Stargazers Issues MIT License LinkedIn

Logo

hmounir.com - v2

The second iteration of hmounir.com built with Gatsby and hosted with Netlify

Previous iterations: v1

Netlify Status

Generate Typescript code from protobuf message
Report Bug Β· Request Feature

demo

πŸ›  Installation & Set Up

  1. Install the Gatsby CLI

    npm install -g gatsby-cli
  2. Install and use the correct version of Node using NVM

    nvm install
  3. Install dependencies

    yarn
  4. Start the development server

    npm start

πŸš€ Building and Running for Production

  1. Generate a full static production build

    npm run build
  2. Preview the site as it will appear once deployed

    npm run serve

🎨 Color Reference

Color Hex
Navy #0a192f #0a192f
Light Navy #112240 #112240
Lightest Navy #233554 #233554
Slate #8892b0 #8892b0
Light Slate #a8b2d1 #a8b2d1
Lightest Slate #ccd6f6 #ccd6f6
White #e6f1ff #e6f1ff
Green #64ffda #64ffda

Credits

Big up to Brittany Chiang for her project that inspire me to adapt it on m own, Thanks!

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Hamza Mounir - @pixlhamza - hamza.pixelle@gmail.com

Support

Contributions, issues, and feature requests are welcome!

Give a ⭐️ if you like this project!

Acknowledgments

Project base from bchiang7-v4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment