diff --git a/README.md b/README.md index e69de29..2634e22 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,56 @@ +# Landing-webpage Point Blank + +![Powered by Vercel](website/static/img/powered-by-vercel.svg) + +This is the landing page of Point Blank. A coding community of Dayananda Sagar College of Engineering, Bangalore. The site is deployed on Vercel. + +## What is Point Blank? + +A Community Focused towards development of Industry ready engineers as wholesome individuals. + +## Development Setup + +Before setting up the project make sure the LTS (Long Term Support) version of NodeJs is installed with a package manager of your choice. We recommend NPM or Yarn. +Steps to install NodeJs [Here](https://nodejs.org/en/download/) + + +1. Fork the repository. + +2. Clone the repository. + +``` + https://github.com//landing-pagepwd.git +``` + +3. Go into the directory containing the project. + +``` + cd landing-page +``` + +4. Install all the dependencies + +``` + yarn install +``` + +5. Start the development server. + +``` + yarn start +``` + +6. Build the Community website: + +```sh + yarn build +``` + +7. Serve an optimized production build: + +```sh + yarn serve +``` + + +The site starts at http://localhost:3000/ after starting the server. \ No newline at end of file