ARC Website: Tailwind + NextJS

First Timer Guide

Create a Github account
Install git command line on your Device
Connect it with SSH

From here you have 2 methods:

Docker Method(Simple Method)
- Install Docker
- Go into the cloned folder
- Run docker build -t arcnextapp .
- And then run docker run -it -p 3000:3000 arcnextapp
Manual Installation Method
- Install NodeJS, preferably LTS and using Node Version Manager
- Use this link for NVM is using windows
- Open Terminal
- Clone this repo using git clone URL
- You get the URL when you click on Code above
- Use cd and other commands to move into the directory where you have cloned the repo
- Run npm install
- Run npm start or npm run dev and ppen http://localhost:3000 with your browser to see the result.

Instructions for Maintaining the Website

Here are some Instructions for the future developers:

NOTE: mdx and md files go into the data folder

Add Resources

To add resources
- Here resources denotes the category of resource, eg. LevelUp or say Processing
- Add the md/mdx files in the resources/resource_name folder
- Then add the images to public/static/images/resourcenameResources
- Please follow this process and don't add images anywhere else
NOTE: Ensure you add TOCInline component for the resources so that you get a table of contents <TOCInline toc={props.toc} toHeading={3} asDisclosure />
Also ensure the md/mdx files under resources do have orderInSidebar parameter

Add Projects

All the project posts go in the data/projects folder

Add your details

  {
    Timestamp: '2022-08-17T11:07:20.271Z',
    email: 'BITS EMAIL',
    name: 'NAME',
    picture: '/static/members/NAME.jpg',
    github: 'github',
    linkedin: 'linkedin',
    facebook: 'facebook',
  },

Add this to the last in the data/membersData.js file and send a PR Also upload your pic to /static/members/

Making Posts

Frontmatter

NOTE: Go through Markdown Guide for help regarding what markdown is and how it is used Currently the following fields are supported.

title (required)
date (required)
tags (required, can be empty array)
lastmod (optional)
draft (optional)
summary (optional)
images (optional, if none provided defaults to socialBanner in siteMetadata config)
authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)
layout (optional list which should correspond to the file names in `data/layouts`)
canonicalUrl (optional, canonical url for the post for SEO)
cover (image that shows up as thumbnail)

Here's an example of a post's frontmatter:

---
title: Gesture Controlled Bot
tags: [l298n, HC-05, MATLAB, Image Processing]
date: 2015-07-04
mode: normal
type: article
sharing: true
author: Suyash Yeotikar
show_author_profile: true
show_title: true
full_width: false
header: true
cover: /static/images/projects/thumbnails/Gesture Controlled Bot.png
---

Adding Images

For specific size

<Image src="/static/images/projects/Robotic-Arm/2.png" alt="Resistor" width="500" height="500" />

Otherwise

![Image](Image Address)

Adding youtube videos

<EmbedItem url="https://www.youtube.com/embed/OffjpoCmOaU" />

Adding Image Sliders

<ImageSwiper
  imageArray={[
    '/static/images/levelup/level-1/jumper1.png',
    '/static/images/levelup/level-1/jumper2.png',
  ]}
/>

Working on Issues

Work in branches to avoid clash with the main branch Basically create a new branch with your_name/feature you were working on so that it doesn't clash with the deployment version
Whenever you want to work on an issue, do git checkout -b branch_name and make changes here
Then use git push to push the code on the new branch
Solve Issues

Creating new pages

Inorder to create a new route

Create a new base page in the pages
If it's supposed to work with slugs, just replicate an existing folder such as projects
Then make a Layout for the same in the layouts directory
Then figure it out :)

arc-bphc/arc-site