Skip to content

Commit

Permalink
docs: 📝 Improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
5ika committed May 24, 2022
1 parent 9a12933 commit 79ea191
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 15 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Contributing to Genève Open-Source

This project is young and fully open to suggestions of features or codes.
Feel free to create an issue or PR to propose modifications or corrections directly on GitHub.

We hope to grow this project with you !
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
This project is an eco-conceptualized website listing the open-source projects.
Projects list is retrieved from an Airtable database.

## Getting Started

First, run the development server:
First, set environment variables:

```bash
cp .env.sample .env.local
```

- `AIRTABLE_API_KEY`: Secret key for Airtable API access
- `AIRTABLE_BASE`: Airtable database ID with projects list
- `PROPOSAL_URL`: URL to proposal form
- `SUBSCRIBE_URL`: URL for newsletter subscription form

Then, run the development server:

```bash
npm run dev
Expand All @@ -12,14 +24,9 @@ yarn dev

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## Learn More

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
Expand Down
5 changes: 3 additions & 2 deletions pages/_app.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Head from "next/head";
import Script from "next/script";
import "../styles/globals.css";

function MyApp({ Component, pageProps }) {
Expand All @@ -12,12 +13,12 @@ function MyApp({ Component, pageProps }) {
name="description"
content="Site référençant les applications Open Source qui concernent Genève et sa région."
/>
<script
<Script
async
defer
data-website-id="f31f8a0d-af9c-484e-adb9-2c454b00d5f9"
src="https://umami.hidora.com/umami.js"
></script>
></Script>
</Head>
<Component {...pageProps} />
</>
Expand Down
10 changes: 5 additions & 5 deletions pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import Layout from "../layouts/default";
import ProjectsList from "../containers/ProjectsList";
import { getProjectsList } from "../lib/getProjectsList";

# Genève Open Source
# Genève Open-Source

La région de Genève est à la fois riche en données libres d’accès (Open Data) et riche en compétences techniques,
notamment de développement. Pourtant, il existe peu de projets communautaires dans lesquels développeurs et développeuses
de la région peuvent s’engager à la création de biens communs digitaux.

Cette plateforme vise à donner de la visibilité sur les projets Open Source existants qui concernent la région de Genève et ses environs.
Cette plateforme vise à donner de la visibilité sur les projets Open-Source existants qui concernent la région de Genève et ses environs.

## Les projets existants

Expand All @@ -20,13 +20,13 @@ Que vous soyez senior, junior ou amateur, vous pouvez toujours donner un coup de
Vous pouvez commencer simplement en corrigeant une documentation, en repérant des bugs ou en rendant
le lancement d’une app plus aisée. Il n’y a pas de petite contribution !

Pour plus d’informations sur comment contribuer à un projet Open Source, nous vous invitons à lire
Pour plus d’informations sur comment contribuer à un projet Open-Source, nous vous invitons à lire
[https://opensource.guide/fr/how-to-contribute/](https://opensource.guide/fr/how-to-contribute/).

## Un projet à ajouter ?

La liste des projets est encore courte. Si vous avez un projet existant ou souhaitez créer un nouveau
projet Open Source qui concerne Genève et sa région, contactez-nous pour que l’on puisse faire grandir la liste.
projet Open-Source qui concerne Genève et sa région, contactez-nous pour que l’on puisse faire grandir la liste.

<div className="center">
<a href={props.proposalUrl} target="_blank">
Expand Down Expand Up @@ -55,7 +55,7 @@ Pour toute question ou remarque, vous pouvez nous contactez par l'adresse [info@
</div>

<div className="footer center">
© 2022 Genève Open Source — [AGPL License
© 2022 Genève Open-Source — [AGPL License
v3.0](https://github.com/5ika/Geneve-Open-Source/blob/main/LICENSE.md)
</div>

Expand Down

0 comments on commit 79ea191

Please sign in to comment.