Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MichaelCurrin/instant-website

The fastest way to make and share a webpage about a product/business/person
https://github.com/MichaelCurrin/instant-website

custom dynamic form html instant javascript netlify react react-url-query url-parameters webpage

Last synced: 3 months ago
JSON representation

The fastest way to make and share a webpage about a product/business/person

Awesome Lists containing this project

README

        

# Instant Website 🏭 ⌛ 🧙‍♂️
> The fastest way to make and share a webpage about a product/business/person

[![Netlify Status](https://api.netlify.com/api/v1/badges/8f1fc5a5-1b67-4d14-94c6-512c4eacdad7/deploy-status)](https://app.netlify.com/sites/instant-website/deploys)
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/instant-website.svg)](https://github.com/MichaelCurrin/instant-website/releases)
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Node.js](https://img.shields.io/badge/Node->=12-blue?logo=node.js&logoColor=white)](https://nodejs.org "Go to Node homepage")

[![Package - react](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/instant-website/react?logo=react&logoColor=white)](https://www.npmjs.com/package/react "Go to react on NPM")
[![Package - react-url-query](https://img.shields.io/github/package-json/dependency-version/MichaelCurrin/instant-website/react-url-query?logo=react&logoColor=white)](https://www.npmjs.com/package/react-url-query "Go to react-url-query on NPM")
[![Made with Bulma](https://img.shields.io/badge/Made_with-Bulma-blue.svg)](https://bulma.io/ "Go to Bulma homepage")
[![Known Vulnerabilities](https://snyk.io/test/github/MichaelCurrin/instant-website/badge.svg?targetFile=package.json)](https://snyk.io/test/github/MichaelCurrin/instant-website?targetFile=package.json "Go to Snyk page")

Manifest a business idea as a simple webpage - using custom text and images supplied in a URL and no coding

## Preview



Sample screenshot

## Project website

[![Site link](https://img.shields.io/badge/web_app-Instant_Website-2ea44f?style=for-the-badge)](https://instant-website.netlify.app/)

A simple one-page React app which lets you build a landing page for a brand using a form. And you can share the page using the URL as it has all the details in the params.

This is my first React app and could do with refactoring when I get round to it but now I am just stoked to see that it works how I want and is shareable.

## Documentation

### User guide

[![Wiki](https://img.shields.io/badge/User_guide-Wiki-blue?style=for-the-badge)](https://github.com/MichaelCurrin/instant-website/wiki)

### Dev docs

See the docs site to setup locally or on a remote environment. Or just to learn how the project works using Bulma styling, React, Netlify and Unsplash.

[![View site](https://img.shields.io/badge/View-Online_docs-blue?style=for-the-badge)](https://MichaelCurrin.github.io/instant-website/)

## Contributing

There are a lot of issues on the repo - some might never get done or make the others unneeded when a choice is made. I am happy with the how the single page site works for now and am adding to the Wiki for now to keep things simple. Please update the Wiki's [Showcase](https://github.com/MichaelCurrin/instant-website/wiki/Showcase) section with your own creations if you want to share them.

If you do make a PR against this repo's `master` branch, you'll get a Netlify preview URL so you can **preview** your result on the existing Netlify app.

## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).

You must include a copy of the source license in your own repo if you use a substantial part of the code - if you copy a few lines here or there or just take inspiration then you don't need to worry but please still give credit back to this project.

If forking as a separate project (not to contribute), please copy `LICENSE` to `LICENSE-source` to keep the original license and then you can add your own `LICENSE` file.

This project was created for hobby use for myself and friends and people who stumble on it to play with and prototype with. This is not intended to be used for commercial use. You may fork this project and use some or all of it, but you give credit in your docs and on the site to link back to the original Instant Website repo.

It's my first React app so the React might not be so good but hopefully you can find parts you can reuse in your own app such as forms or query parameters or pullin in a random image.