aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBobby <[email protected]>2022-03-20 01:01:30 -0400
committerBobby <[email protected]>2022-03-20 01:01:30 -0400
commit977427063d7c769fcbf188c9f169fe7f9b5e5211 (patch)
treee64efda31dbc48d76d3f1d3516e32f580d6bf9b6
parentcbac553ec36b33e4036469cb3643bb4c8872c60d (diff)
downloadluciferreeves.github.io-977427063d7c769fcbf188c9f169fe7f9b5e5211.tar.xz
luciferreeves.github.io-977427063d7c769fcbf188c9f169fe7f9b5e5211.zip
update readme
-rw-r--r--README.md54
1 files changed, 51 insertions, 3 deletions
diff --git a/README.md b/README.md
index c6540b2..3319efd 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,52 @@
-# luciferreeves.github.io
-Personal Website
+# Personal Website
+
+![Lines of code](https://img.shields.io/tokei/lines/github/luciferreeves/luciferreeves.github.io?label=lines%20of%20code) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/luciferreeves/luciferreeves.github.io/Fly%20Deploy) ![GitHub](https://img.shields.io/github/license/luciferreeves/luciferreeves.github.io) ![Website](https://img.shields.io/website?down_color=red&down_message=offline&up_color=green&up_message=online&url=https%3A%2F%2Fthatcomputerscientist.com) ![Docker Deployment](https://img.shields.io/badge/deployed%20using-docker-informational)
+
+## Cloning & Running Locally
+
+To clone the project, run the following command in a terminal window:
+
+```bash
+git clone https://github.com/luciferreeves/luciferreeves.github.io.git
+```
+
+Inside the cloned directory, run the following command to install dependencies:
+
+```bash
+npm install
+```
+
+Run the following command to start the development server:
+
+```bash
+npm run dev
+```
+
+## Frameworks and Technologies
+
+- [ExpressJS](https://expressjs.com/)
+- [HTML5](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5)
+- [CSS3](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS3)
+- [BOOTSTRA.386](http://kristopolous.github.io/BOOTSTRA.386/)
+- [JQuery](https://jquery.com/)
+- [NodeJS](https://nodejs.org/)
+- [Firebase](https://firebase.google.com/)
+- [Git](https://git-scm.com/)
+- [KaTeX](https://katex.org/)
+- [HighlightJS](https://highlightjs.org/)
+- [Marked](https://marked.js.org/)
+- [CORS - NPM](https://www.npmjs.com/package/cors)
+- [dotenv](https://www.npmjs.com/package/dotenv)
+- [node-fetch](https://www.npmjs.com/package/node-fetch)
+- [shelljs](https://www.npmjs.com/package/shelljs)
+- [cheerio](https://www.npmjs.com/package/cheerio)
+- [@octokit/rest](https://www.npmjs.com/package/@octokit/rest)
+- [Github GraphQL API](https://docs.github.com/en/graphql)
+- [nodemon](https://www.npmjs.com/package/nodemon)
+- [Chart.JS](https://www.chartjs.org/)
+
+## Fonts
+- [Fira Code](https://fonts.google.com/specimen/Fira+Code)
+- [Fixedsys](https://en.wikipedia.org/wiki/Fixedsys)
+- [Px437 IBM EGA8](https://fontinfo.opensuse.org/families/Px437IBMEGA8.html)
--- Under Construction --