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 A README TO PROJECT #2

Open
sm-creative-crazy4code opened this issue Mar 23, 2023 · 0 comments
Open

ADD A README TO PROJECT #2

sm-creative-crazy4code opened this issue Mar 23, 2023 · 0 comments

Comments

@sm-creative-crazy4code
Copy link
Collaborator

this project is basically the metaverse society website for IIIT Bhubaneshwar and hence is requires a proper readme file for maintenance of code base . To give a brief overview of the project architecture it is a simple website which uses the fallowing tech-stacks
1.FRONTEND: Vite+React.js, Framer Motion, Tailwind CSS
2.BACKEND:Nodejs,Mongo Db

the readme for the project will fallow the fallowing structure and content must be developed and mentioned under the fallowing header only

  1. BASIC PROJECT INTRODUCTION : will contain the basic idea of the project
  2. TECHNOLOGIES USED : list of all the tech stacks used .Though only listing them will be fine but the mentions about the utility of
    each tech stack in the project is highly appreciated
    4.PROJECT ARCHITECTURE: providing the description of folder structure to make it clear what is contained in each file to give a clarity about the project
  3. LOCAL SETUP : step wise instruction on how to setup the project on local system and it will contain separate set of instruction for the frontend and backend

please keep in mind the requirements before making the pr that

  1. To strictly fallow the above mentioned structure for readme
  2. To strictly fallow the markdown syntax
  3. To avoid any invalid or redundant information
  4. crisp and concise content

Looking forward to wonderful and valuable contributions

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

No branches or pull requests

1 participant