-
-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Only use gh-pages for doc single entry-point (ease of maintainance)
- Loading branch information
1 parent
5172853
commit 1332cb8
Showing
1 changed file
with
1 addition
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1 @@ | ||
| <a href="https://unly.org"><img src="https://storage.googleapis.com/unly/images/ICON_UNLY.png" align="right" height="20" alt="Unly logo" title="Unly logo" /></a> | ||
| [](https://codeclimate.com/github/UnlyEd/next-right-now/maintainability) | ||
| [](https://codeclimate.com/github/UnlyEd/next-right-now/test_coverage) | ||
| [](https://www.locize.app/p/w7jrmdie/statistics/badges) | ||
| [](https://www.locize.app/p/w7jrmdie/statistics/badges) | ||
|
|
||
| Next Right Now | ||
| === | ||
|
|
||
| > **Current preset**: [`v1-ssr-mst-aptd-gcms-lcz-sty`](#overview-of-available-presets) (DEFAULT preset) | ||
| --- | ||
|
|
||
| > Next Right Now (NRN) is meant to be used as a **boilerplate** for quick getting started with a **production-grade** project featuring the **Next.js framework**, hosted on **Zeit** platform. | ||
| > | ||
| > NRN is maintained with several purposes in mind: | ||
| > - To be **flexible** and allow for extensive **customisation**. | ||
| > - To be used as an **educational** resource, meant to be used as a **learning/teaching** resource. | ||
| > - Provide various boilerplate [presets](https://unlyed.github.io/next-right-now/concepts/presets), to get started with the preset that matches the closest your needs. | ||
| > - To be used as a **boilerplate** to quickly deploy a **new** project. | ||
| > - It has been used to build production-grade websites within 2h time during a French COVID-19 hackathon (March 2020) | ||
| > - It has been used to build [NRN Admin](https://github.com/UnlyEd/next-right-now-admin) | ||
| > | ||
| > Don't hesitate to share your opinion about your ["getting started"](https://github.com/UnlyEd/next-right-now/issues/14) experience and your [feedback about opt-in 3rd parties](https://github.com/UnlyEd/next-right-now/issues/13)! | ||
| :point_right: [**Documentation: Overview & benefits (getting started)**](https://unlyed.github.io/next-right-now/). :point_left: | ||
|
|
||
| --- | ||
|
|
||
| # Overview of available presets | ||
|
|
||
| > Make sure to check our [presets doc](https://unlyed.github.io/next-right-now/getting-started/select-preset) for a comprehensive list. | ||
| | Preset | Links | Demo | Features | Notes | | ||
| |:-------|:------|:-----|:---------|:------| | ||
| | `v1-ssr-mst-aptd-gcms-lcz-sty` | - [Doc](https://unlyed.github.io/next-right-now/getting-started/select-preset#v1-ssr-mst-aptd-gcms-lcz-sty----ssr--mst--amplitude--graphcms--locize--sentry) <br /> - [Branch](https://github.com/UnlyEd/next-right-now/tree/v1-ssr-mst-aptd-gcms-lcz-sty) <br /> - [Diff `origin`...`target`](https://github.com/UnlyEd/next-right-now/compare/master...v1-ssr-mst-aptd-gcms-lcz-sty) <br /> - [Diff `target`...`origin`](https://github.com/UnlyEd/next-right-now/compare/v1-ssr-mst-aptd-gcms-lcz-sty...master) | - [Customer 1](https://nrn-v1-ssr-mst-aptd-gcms-lcz-sty-c1.now.sh/) <br /> - [Customer 2](https://nrn-v1-ssr-mst-aptd-gcms-lcz-sty-c2.now.sh/) | - Analytics (Amplitude)<br />- GraphQL (GraphCMS)<br />- I18n (GraphCMS + Locize)<br />- Monitoring (Sentry) | **Default preset**<br />There should be no difference between it and master. | | ||
|
|
||
| --- | ||
|
|
||
| # FAQ | ||
|
|
||
| [Go to our community FAQ](https://unlyed.github.io/next-right-now/FAQ). | ||
|
|
||
| --- | ||
|
|
||
| # Contributing | ||
|
|
||
| [Go to our contributing guide](https://unlyed.github.io/next-right-now/CONTRIBUTING). | ||
|
|
||
| --- | ||
|
|
||
| # License | ||
|
|
||
| [MIT](LICENSE) | ||
|
|
||
| --- | ||
|
|
||
| # Vulnerability disclosure | ||
|
|
||
| [See our policy](https://github.com/UnlyEd/Unly). | ||
|
|
||
| --- | ||
|
|
||
| # Contributors and maintainers | ||
|
|
||
| This project is being maintained by: | ||
| - [Unly] Ambroise Dhenain ([Vadorequest](https://github.com/vadorequest)) **(active)** | ||
|
|
||
| Special thanks to: | ||
| - [Contributor] Hugo Martin ([Demmonius](https://github.com/Demmonius)) - Github Actions CI/CD pipeline | ||
|
|
||
| --- | ||
|
|
||
| # **[ABOUT UNLY]** <a href="https://unly.org"><img src="https://storage.googleapis.com/unly/images/ICON_UNLY.png" height="40" align="right" alt="Unly logo" title="Unly logo" /></a> | ||
|
|
||
| > [Unly](https://unly.org) is a socially responsible company, fighting inequality and facilitating access to higher education. | ||
| > Unly is committed to making education more inclusive, through responsible funding for students. | ||
| We provide technological solutions to help students find the necessary funding for their studies. | ||
|
|
||
| We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit : | ||
| - https://twitter.com/UnlyEd | ||
| - https://www.facebook.com/UnlyEd/ | ||
| - https://www.linkedin.com/company/unly | ||
| - [Interested to work with us?](https://jobs.zenploy.io/unly/about) | ||
|
|
||
| Tech tips and tricks from our CTO on our [Medium page](https://medium.com/unly-org/tech/home)! | ||
|
|
||
| #TECHFORGOOD #EDUCATIONFORALL | ||
| # [Go to documentation](https://github.com/UnlyEd/next-right-now) |