MelanieL/dev-codex

(In development) A basic project using HTML, CSS, SCSS/SASS and JavaScript that holds all my bookmarked developer tools in one place.

โ˜… 0Forks 0SCSSGitHub โ†—Compare

README

Developer Codex

Description ๐Ÿ“š

A basic project using HTML, CSS, SCSS/SASS and JavaScript that holds all my bookmarked developer tools in one place.

(back to top)

Status ๐Ÿ“ถ

This project is currently in development.

(back to top)

Technologies Used โ˜•๏ธ

(back to top)

Inspiration ๐Ÿ“š

A few years ago I created a project called Front-End Codex (deprecated/archived). It was meant to be a public listing of all the tools I liked to use, even the ones I don't use often. At the time I also wanted to try building a project using some basic Bootstrap.

I find myself in regular conversations with other devs where I mention a tool or resource that I'd like to connect them with. I also prefer something easy so I don't have to sign into Google every time I want to access to one bookmark. This is a solid (and safe!) solution for these problems.

I decided to create a new version of that project using some different tools. My "toolbox" has changed over the years, and so have my skills to build a project like this.

I also want a simple project where I can practice the basics (HTML, CSS, JAVASCRIPT, SCSS/SASS). Sometimes it's nice when you read about updates, especially to HTML and CSS, to have a practical place to try them out.

I hope you find some things here that you can use!

(back to top)

Approach/Planning ๐Ÿšถ

  • White board rough sketch of front end
  • Identify MVPs vs Stretch Goals
  • Identify timeline

(back to top)

Setup / Installation ๐Ÿ’ป

  1. Git clone the repo to your local machine
  2. In the root folder, run npm install

SCSS/SASS Commands

Package information: local-web-server

  1. To watch for changes and re-compile SCSS/SASS: npm run sass-watch

(back to top)

Recommended Extension for VS Code

You may run into errors with the JS modules if you aren't previewing with HTTP. I recommend using the Live Server extension on VS Code to run a simple local server.

(back to top)

License ยฉ๏ธ

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

(back to top)

Credits ๐Ÿ“

  • Coolors - I decided to use the generator and use the first palette it came up with.
  • Bootstrap - This project isn't using Bootstrap, but it's following the max-width they use on containers.

(back to top)

Contributors

MelanieL

Issues