Skip to content
Snippets Groups Projects
README.md 2.38 KiB
Newer Older
Julien MARGAIL's avatar
Julien MARGAIL committed
<h1 align="center">
Gatsby Onegeo Portal Starter
</h1>
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
This repo hosted on git.neogeo.fr is mirrored to gitlab.com (read only) for gatsby CLI
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
## 🚀 Quick start
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
1.  **Create a Gatsby site.**
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    Use the Gatsby CLI to create a new site, specifying the starter.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    ```bash
    gatsby new portal https://gitlab.com/geofit/gatsby-starter-onegeo.git
    ```
Julien MARGAIL's avatar
Julien MARGAIL committed

    **Note**: @onegeo-suite/gatsby-theme-onegeo is already installed with this template.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    From portal folder
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    Edit portal .env file (from .sample.env)
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    ```bash
    cd portal
    mv .sample.env .env
    nano .env
    ```
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    ```bash
    PF_DOMAIN=
    PF_PORT=443
    PF_PROTOCOL=https
    PF_URL=${PF_PROTOCOL}://${PF_DOMAIN}:${PF_PORT}
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    DIRECTUS_URL=${PF_URL}/directus/
    DIRECTUS_TOKEN=
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    TYPESENSE_API_TOKEN=
    ```
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
1.  **Start developing.**
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    Navigate into your new site’s directory and start it up.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    ```bash
    gatsby develop
    ```
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
1.  **Open the source code and start editing!**
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    Your site is now running at http://localhost:8000
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    **Note**: You'll also see a second link: http://localhost:8000/\_\_\_graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    Open the my-default-starter directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
1.  **Initial Commit & Push to Git repository**
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    You need to create a empty project first on gitlab.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    From command line
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    ```bash
    cd portal/
    git remote add origin https://git.neogeo.fr/{group}/{project_name}.git
    git add .
    git commit -m "Initial commit"
    git push -u origin main
    ```
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
    From VS Code  
    Todo...
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
## Config gatsby-theme-onegeo
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
TODO...
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
## 🎓 Learning Gatsby
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
Julien MARGAIL's avatar
Julien MARGAIL committed

Julien MARGAIL's avatar
Julien MARGAIL committed
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
Julien MARGAIL's avatar
Julien MARGAIL committed

## License

Julien MARGAIL's avatar
Julien MARGAIL committed
MIT