/console

A scif-fi retro style MS-DOS console built with ReactJS

Primary LanguageJavaScriptMIT LicenseMIT

Alt text

View a live version here: http://sickdyd.github.io/console/

How to install

Clone the repository and run npm install. Then run npm start (more details below).

How to navigate

You can navigate this website by typing commands or by clicking on the links.

The available commands are:

AUTHOR: Shows information about the author of this website.
CLEAR: Clears the console.
DIR: Displays a list of files and subdirectories in a directory.
HELP: Provides Help information for the console commands.
INFO: Get some technical information about the console.
TOGGLE: Toggle background text-shadow effect to improve performance.

Info

Hover the mouse on the background to zoom articles, click to open.

You can drag the console around and resize it.

The page is still work in progress and so far it has been tested only on Firefox and Chrome.

Dependencies

axios: Promise based HTTP client for the browser and node.js.
dompurify: DOMPurify is an XSS sanitizer for HTML, MathML and SVG.
uuidv4: Creates v4 UUIDs.
react-device-detect: Detect device, and render view according to detected device type.
react-draggable: A simple component for making elements draggable.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify