Skip to content
This repository has been archived by the owner on Jan 16, 2021. It is now read-only.

Add Image Component #194

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Replaced font-family Calibri for Spectral. The new font is open source and was s

#### :nail_care: Enhancement

https://github.com/Jam3/generator-jam3/pull/50
https://github.com/Jam3/generator-jam3-v2/pull/50

* Add include-media
* [PR #50](https://github.com/Jam3/generator-jam3/pull/50) Feature - CSS Font and Media query
* [PR #50](https://github.com/Jam3/generator-jam3-v2/pull/50) Feature - CSS Font and Media query
* Replace licensed font for open source font
* [PR #50](https://github.com/Jam3/generator-jam3/pull/50) Feature - CSS Font and Media query
* [PR #50](https://github.com/Jam3/generator-jam3-v2/pull/50) Feature - CSS Font and Media query

### Thanks
Thanks to @n0wak
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We are using [react-scripts](https://github.com/facebook/create-react-app/tree/n

The purpose of this tool is to generate an opinionated template with the Jam3's standards and best practices. This template doesn't have configurations or prompts like [yeoman](http://yeoman.io/) or [nyg](https://www.npmjs.com/package/nyg)

We included in the project the most commonly used components and directory structure, it doesn't mean you need to use all of it and in that case our strategy is to delete those files instead of having a massive configuration file with many different cases, as this is usually hard to maintain. Probably in the future we decide to fork `react-scripts` but hasn't been decided.
We included in the project the most commonly used components and directory structure, it doesn't mean you need to use all of it and in that case our strategy is to delete those files instead of having a massive configuration file with many different cases, as this is usually hard to maintain.

### Convention

Expand Down Expand Up @@ -64,7 +64,7 @@ The entry point of the generator is `index.js`, this file is in charge of:

## Setting Up a Local Copy

1. Clone the repo with `git clone https://github.com/Jam3/generator-jam3.git`
1. Clone the repo with `git clone https://github.com/Jam3/generator-jam3-v2.git`
2. Here you can start contributing with:
1. The generator, modifing the `index.js`
2. The template that will be generated inside `templates/*`
Expand Down
52 changes: 22 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,21 @@
# Jam3 Generator [![stable](http://hughsk.github.io/stability-badges/dist/stable.svg)](http://github.com/hughsk/stability-badges)

Jam3 Frontend App Generator with no build configuration and no prompts.
Jam3 Frontend App Generator with no build configuration and no prompts. The project is still in development and has not been officially released

* [Usage](#usage)
* [Developer Contribution Guide](https://github.com/Jam3/generator-jam3/blob/master/CONTRIBUTING.md) – Read first if you are a developer
* [Developer Contribution Guide](https://github.com/Jam3/generator-jam3-v2/blob/master/CONTRIBUTING.md) – Read first if you are a developer
* [Developer Guide](#developer-guide) – How to develop apps bootstrapped with the generator
* [Main scripts](#main-scripts) – Running scripts
* [Publishing to production](#publishing-to-production) - A couple notes about publishing

## Usage

[![NPM](https://nodei.co/npm/nyg-jam3.png)](https://www.npmjs.com/package/nyg-jam3)
## Setting up a new project

To create a new project based on the generator there are a few ways:

1. Using the generator npm package.
2. Generate the output template.
1. Generate the template output.
2. Using the generator npm package.
3. Copy and paste and update some values in the template.

### Using the npm package

The nyg generator is designed to function similar to yeoman. To get it running, simply follow these steps:
```bash
npm i nyg -g
npm i nyg-jam3 -g
cd your-project-directory
nyg nyg-jam3
```

### Generate the output template
### Generate the template output

Do this if you have the source code and want to generate a version ready to be used in a project.

Expand All @@ -36,6 +24,17 @@ Do this if you have the source code and want to generate a version ready to be u
3. Copy/Paste the files in `/test/output/` into your project folder.
4. Update the `README.md` and `package.json`

### Using the npm package

Note: The latest version hasn't been released yet, the current verion on npm is the old version of the generator

```
npm i nyg -g
npm i nyg-jam3 -g
cd your-project-directory
nyg nyg-jam3
```

### Copy and paste

If you want to do the quick and raw path, just copy `templates` folder and review the post install that the generator is doing after copying the files: https://github.com/Jam3/intern-generator-jam3/blob/master/index.js#L23
Expand All @@ -57,13 +56,13 @@ Changes:

1. Review `/index.js`, everything is there

If you are looking to contribute with the generator is important to read the [Developer Contribution Guide](https://github.com/Jam3/generator-jam3/blob/master/CONTRIBUTING.md)
If you are looking to contribute with the generator it is important to read the [Developer Contribution Guide](https://github.com/Jam3/generator-jam3-v2/blob/master/CONTRIBUTING.md)

## Developer Guide

We are using `react-scripts` as a base; you can checkout their [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md). Everything here applies the generator.

You can checkout our [Developer Guides](https://github.com/Jam3/generator-jam3/blob/master/templates/docs/DEVELOPER_GUIDE.md) to know more about the features and customizations.
You can checkout our [Developer Guides](https://github.com/Jam3/generator-jam3-v2/blob/master/templates/docs/DEVELOPER_GUIDE.md) to know more about the available features and customizations.

## Main scripts

Expand All @@ -85,8 +84,6 @@ It correctly bundles React in production mode and optimizes the build for the be
The build is minified and the filenames include the random hash strings in order to avoid server-side caching. (example: main.df8fsdfs.js)<br>
By default, it also [includes a service worker](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) so that your app loads from local cache on future visits.

Before create the production build make sure removing everything you don't need. There are many samples in the generator to avoid prompting at the beginning of the project.

Your app is ready to be deployed.

### `npm test`
Expand All @@ -110,11 +107,6 @@ Before creating the production build make sure to remove everything you don't ne
* `/assets` folder
* `/pages` folder

Your app is ready to be deployed.

### `npm test`
### Run deploy scripts

Runs the test watcher in an interactive mode.<br>
By default, runs tests related to files changed since the last commit.

[Read more about testing.](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
Running `npm run build` will do all the magic. It will create a main css bundle, a main js bundle and chunks for the asynchrounous requests.
2 changes: 1 addition & 1 deletion nyg-cfg.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"nyg-version":"2.8.0","generator-version":"4.0.0","folder":"generator-jam3"}
{"nyg-version":"2.8.0","generator-version":"0.1.0","folder":"intern-generator-jam3"}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 7 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "generator-jam3",
"version": "4.0.0",
"description": "Jam3 project scaffold generator based on nyg",
"name": "generator-jam3-v2",
"version": "0.1.0",
"description": "Second generation of the Jam3 Generator, many new features and breaking feature changes.",
"main": "index.js",
"scripts": {
"test": "node test/",
Expand All @@ -11,26 +11,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/Jam3/generator-jam3.git"
"url": "git+https://github.com/Jam3/generator-jam3-v2.git"
},
"contributors": [
"Iran Reyes <[email protected]>",
"Vadim Namniak <[email protected]>",
"Jacob Jang <[email protected]>",
"Benson Wong <[email protected]>",
"Nick Poisson <[email protected]>",
"Neo Li <[email protected]>",
"Mike Nowak <[email protected]>",
"Ragu Sivanandha <[email protected]>",
"Craig Hill <[email protected]>",
"Santiago D'Antuoni <[email protected]>",
"William To <[email protected]>"
],
"author": "Iran Reyes <[email protected]> (http://www.iranreyes.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/Jam3/generator-jam3/issues"
"url": "https://github.com/Jam3/generator-jam3-v2/issues"
},
"homepage": "https://github.com/Jam3/generator-jam3#readme",
"homepage": "https://github.com/Jam3/generator-jam3-v2#readme",
"dependencies": {
"nyg": "^2.8.0"
},
Expand Down
37 changes: 19 additions & 18 deletions templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

## Jam3 Generator

This application was created using the [Jam3 Generator](https://github.com/Jam3/generator-jam3). To checkout the out
This application was created using the [Jam3 Generator](https://github.com/Jam3/generator-jam3-v2). To checkout the out
of the box features read our [Developer guide](docs/DEVELOPER_GUIDE.md)

## Getting Started
Expand Down Expand Up @@ -55,11 +55,11 @@ The test runs automatically in the Continue Integration server, in order to exec

## Environments

* Development : [Link]
* Staging : [Link]
* Release (UAT) : [Link]
* Initial Production : [Link]
* Production : [Link]
* Development : [https://dev-prj.jam3.net](https://dev-prj.jam3.net)
* Staging : [https://staging-prj.jam3.net](https://staging-prj.jam3.net)
* Release (UAT) : [https://uat-prj.jam3.net](https://uat-prj.jam3.net)
* Initial Production : [https://prj.jam3.net](https://prj.jam3.net)
* Production : [https://domain.com](https://domain.com)

## Deployment

Expand All @@ -77,12 +77,6 @@ Merging in to the `staging` branch will trigger a deploy to the Staging/QA envir

Review the link in: #environments

#### Release environment

Merge to the `release` branch will trigger a deploy to the Release/UAT environment.

Review the link in: #environments

#### Production environment

Merging in to the `master` branch will trigger a deploy to the Production environment.
Expand All @@ -94,11 +88,18 @@ Review the link in: #environments
To be fully engaged in this project you will need access to the accounts and information below, please feel free to ask for access from the _Lead
Developer_, _Producer_ or _Technical Director_

* Analytic Tools Access
* Environment Access
* CI Access
* Task Management Access
* Team Collaboration Tool Access
* Google Tag Manager
* Google Analytics
* Dev Password
* Staging Password
* Release Password
* Production Password
* Codeship
* Jira
* Slack Channel #prj-[prj-name]
* Slack Channel for development topics #prj-[prj-name]-dev
* Slack Channel for notifications #prj-[prj-name]-i
* Github access for the project

## Contributing

Expand All @@ -116,4 +117,4 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,

## License


This project is privately owned by Jam3
6 changes: 3 additions & 3 deletions templates/docs/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ follow the link.
## Folder Structure

The idea of the generator is don't create magic in order to compose the final boilerplate, based on that idea everything
that is inside [templates](https://github.com/Jam3/generator-jam3/tree/master/templates) will be what we will
that is inside [templates](https://github.com/Jam3/generator-jam3-v2/tree/master/templates) will be what we will
generate.

## NPM Dependencies
Expand Down Expand Up @@ -121,8 +121,8 @@ Our build scripts are based on [react-scripts](https://www.npmjs.com/package/rea
Webpack with different configurations for develop and production. The default configurations are stable and supported
for the community.

To customize the current build pipelines, refer to the file
[config-overrides.js](https://github.com/Jam3/generator-jam3/blob/master/templates/config-overrides.js). If you wanna
To customize the current build pipelines, refer to the file
[config-overrides.js](https://github.com/Jam3/generator-jam3-v2/blob/master/templates/config-overrides.js). If you want to
read more about it, please visit the [react-app-rewired](https://github.com/timarney/react-app-rewired) repository.

### Built-in Customizations
Expand Down
Loading