Git Product home page Git Product logo

knit-website's Introduction

KNIT Events Website

This website serves as the single location to promote information about FABRIC's KNIT events, which are held twice a year.

This website is a React application based off of RENCI/react-starter.

๐Ÿš€ Getting Started

๐Ÿšง Application Development

With Node > 18.13.2 installed, install the dependencies with npm i, and start a local development server with npm start.

๐ŸŽ Building for Production

To build a production-ready bundle, run npm run build from the project root directory. The bundled files will be exported to the dist directory. To build an easily debuggable production build, use npm run build-dev.

Docker

A Dockerfile lives in this repo to help get started with containerized deployment. It is a multi-stage build that results in an bitnami/NGINX image that only serves this application. Note that the resulting image is Sterling-ready.

The command to build an image might look something like the following.

docker build -t knit-website .

To spin up a container from your image, use a command such as the following.

docker run --rm -p 80:8080 knit-website

Content Management

Content for this site is located in the src directory in a content folder. The content is formatted using mdx, and utilizes markdown formatting.

.
โ””โ”€โ”€ src
    โ”œโ”€โ”€ content
        โ”œโ”€โ”€ cfp.mdx
        โ”œโ”€โ”€ home.mdx
        โ”œโ”€โ”€ registration.mdx
        โ””โ”€โ”€ travel.mdx

To update the content, ensure you are on the content branch via the dropdown menu, or, click this link.

Screenshot 2024-08-15 at 1 21 22โ€ฏPM

Then, navigate on the github UI to the file you'd like to change. Find the edit icon (pencil) and edit the text directly in the text editor.

Screenshot 2024-08-15 at 1 22 19โ€ฏPM

When you're changes are complete, click the "Commit changes ... " button. This will open a dialog box that will prompt you to write a commit message, optional description, email address, and the option to choose one of the following options:

  • Commit directly to the content branch
  • Create a new branch for this commit and start a pull request

Please select the second option (Create a new branch for this commit and start a pull request). Our team will be notified of the pull request and will review and merge the requested changes. Or, you can contact a developer who can review and merge the changes based on your timeline and needs.

knit-website's People

Contributors

mbwatson avatar suejinkim20 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.