Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the initial site scaffolding #1

Merged
merged 2 commits into from
Feb 13, 2023
Merged

Conversation

calvellido
Copy link
Member

@calvellido calvellido commented Feb 13, 2023

This PR adds the initial site scaffolding generated through Docusaurus based on the proposed navigation wireframes:

https://www.figma.com/file/gUkwHPakCpJiYWtvg1tKED/arrow-web-v3

All pages and content are currently placeholders, but Markdown documents could already be added to the content/learn directory to have them generated into docs pages.


The site will have different directories depending on their origin, being proper pages (/consulting, /projects) or markdown generated pages (/learn path and /community/blog) path. The latter files will live inside the /content/learn and /content/blog directories, while the rest of the pages will be found under /src/pages.


```
$ npm install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arrow-website % npm install
npm ERR! code ENOENT
npm ERR! syscall open
npm ERR! path /Users/simonvergauwen/Developer/arrow-website/package.json
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, open '/Users/simonvergauwen/Developer/arrow-website/package.json'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/simonvergauwen/.npm/_logs/2023-02-13T10_22_56_532Z-debug-0.log

😢 I don't know anything about npm 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me add some more documentation while I also share it with you!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the following to the README @nomisRev:

Requirements

The site is built through node and npm, and the minimum version required for it to work is:

"node": ">=16.14"

You can check you version by going to your terminal and performing a :

node -v

Depending on your OS and your OS apps/package managers, you could find different methods of having the proper node version installed. Please visit the Node.js website to see the best way for you to have it available in your system.

We recommend the use of a tool like NVM which could ease the installation, and will also allow you to have different node versions coexisting in your system in case you need it. Using a LTS Node.js version is recommended.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you encounter problems following that or find it incomplete, let me know to find the best way to advance on your case, and to explain it to the rest of future users.

Copy link
Member

@nomisRev nomisRev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Working locally 🙌 Thank you @calvellido

@calvellido calvellido merged commit fc38a8d into main Feb 13, 2023
@calvellido calvellido deleted the calvellido-initial-scaffolding branch February 13, 2023 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants