Git Product home page Git Product logo

andy-forecast's Introduction

andy-forecast

Overview

A light weight interface to obtain weather forecast information

Resources

  1. GitHub Respository
  2. Changelog
  3. Trello Board
  4. Deployed App

Technologies

  1. JavaScript
  2. Node.js v.20+
  3. Git
  4. release-please
  5. commitlint
  6. BabelJS
  7. [ESLint] (https://eslint.org/)
  8. Webpack 5
  9. React 18
  10. @svgr/webpack

Set up your local repository

  1. From your command line shell (Bash or Zsh), in a directory of your choice, enter the following command, to create a folder called "andy-client": git clone https://github.com/wingedearth/andy-client.git
  2. Enter cd andy-client to enter the folder.
  3. Enter yarn to run yarn, which will install the local NPM package dependencies. If you do not have yarn installed globally on your machine, then first enter npm i -g yarn to install yarn.

Starting the Application

Development

  1. Enter yarn build:dev on the command line to build/transpile application with Webpack watch mode.
  2. Enter yarn dev on the command line (in a different tab) to start application.

Production

  1. Enter yarn start to build and start the server

Version

When the server is available, use the /version endpoint to see app information.

Conventional Commits

From conventionalcommits.org:

The commit message should be structured as follows:

[optional scope]:

[optional body]

[optional footer(s)] The commit contains the following structural elements, to communicate intent to the consumers of your library:

fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.

Release PRs

Merging code to the master branch will auto generate or update a Release PR. When ready to bump the application version, simply merge the Release PR in GitHub. This will also update the changelog.

andy-forecast's People

Contributors

github-actions[bot] avatar wingedearth avatar

Watchers

 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.