From 5656b2276de7093cad1e6e94bdfb4ec9de3d7547 Mon Sep 17 00:00:00 2001 From: Sumita Canopas <69897605+cp-sumi-k@users.noreply.github.com> Date: Fri, 20 Sep 2024 15:15:26 +0530 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 97266857d..5c0b38b3a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

Website with intuitive UI designs

-We intend to keep this open source. Plan is to keep the repository up to date with latest technologies and best practices. +We intend to keep this open source. The plan is to keep the repository up to date with the latest technologies and best practices. ## Showcase @@ -41,17 +41,17 @@ You can also check out [website](https://canopas.com/) to view a live example of 2. **Go as Backend:** Backend is developed using Golang. Go is a statically typed, compiled language designed for simplicity, efficiency, and concurrency. With its focus on performance and readability, Go offers a robust foundation for building scalable applications. -3. **Server Side Rendering:** We have used Nuxt's different rendering modes for the website. For static pages, its SSG and for dynamic pages, we used SSR/ISR. +3. **Server Side Rendering:** We have used Nuxt's different rendering modes for the website. For static pages, it is SSG and for dynamic pages, we used SSR/ISR. -4. **SEO-friendly URLs and Metadata:** We prioritize SEO best practices to ensure that canopas website receive the visibility they deserve in search engines. From meta tags to URL structure and dynamic sitemaps, canopas website is equipped with all the essential elements for optimal SEO. +4. **SEO-friendly URLs and Metadata:** We prioritize SEO best practices to ensure that the website receives the visibility it deserves in search engines. From meta tags to URL structure and dynamic sitemaps, canopas website is equipped with all the essential elements for optimal SEO. -5. **Responsive and Mobile-friendly Design:** We understand the importance of a mobile-friendly design in modern SEO. Canopas website is fully responsive and adapts seamlessly to various screen sizes, providing a positive user experience across devices. +5. **Responsive and Mobile-friendly Design:** We understand the importance of a mobile-friendly design in modern SEO. Canopas' website is fully responsive and adapts seamlessly to various screen sizes, providing a positive user experience across devices. -6. **CI/CD and Deployment:** With CI in place, every code change is automatically tested and integrated into the main codebase. This ensures that the main branch always remains stable, reducing the chances of bugs and allowing for rapid deployment. This repository contains AWS Lambda, S3 and CloudFront stack for smooth deployment using cloudformation template. +6. **CI/CD and Deployment:** With CI in place, every code change is automatically tested and integrated into the main codebase. This ensures that the main branch always remains stable, reducing the chances of bugs and allowing for rapid deployment. This repository contains AWS Lambda, S3, and CloudFront stack for smooth deployment using a cloudformation template. 7. **Code formatting and linting:** Clean, readable, and consistent code is the foundation of any successful project. This website follows strict code formatting and linting rules, which are enforced through automated tools. This ensures that the codebase remains maintainable and adheres to industry best practices. -8. **reCAPTCHA Integration:** Security is important aspect, especially when it comes to user-generated content. Canopas website integrates reCAPTCHA, a widely trusted CAPTCHA service, to protect your site from spam and abuse while maintaining a user-friendly experience. +8. **reCAPTCHA Integration:** Security is an important aspect, especially when it comes to user-generated content. Canopas website integrates reCAPTCHA, a widely trusted CAPTCHA service, to protect your site from spam and abuse while maintaining a user-friendly experience. --- @@ -63,7 +63,7 @@ You can also check out [website](https://canopas.com/) to view a live example of ## Setup -- Start Go Server +- Start to Go Server ``` go run main.go @@ -85,9 +85,9 @@ You can also check out [website](https://canopas.com/) to view a live example of go mod init ``` -- By running above command go.mod file created in project directory. It includes all packages required in project. +- By running the above command go.mod file created in the project directory. It includes all packages required in the project. -- Add package in project +- Add package to project ``` go get package_name @@ -105,7 +105,7 @@ You can also check out [website](https://canopas.com/) to view a live example of go mod tidy ``` -### For writing unit tests in golang : +### For writing unit tests in Golang: - cd to package for which, you want to write test. @@ -113,23 +113,23 @@ You can also check out [website](https://canopas.com/) to view a live example of cd package_name ``` -- Create file with suffix test like packageName_test.go. +- Create a file with a suffix test like packageName_test.go. -- Create function with prefix Test like TestFunctionName. +- Create a function with the prefix Test like TestFunctionName. -- Run test using +- Run a test using ``` go test . ``` - For cleaning test cache + For cleaning the test cache ``` go clean -testcache ``` - [Here](https://github.com/canopas/canopas-website/blob/master/api-doc.md) is APIs reference used in the website. + [Here](https://github.com/canopas/canopas-website/blob/master/api-doc.md) is an APIs reference used in the website. ### For generating sitemap : @@ -139,7 +139,7 @@ You can also check out [website](https://canopas.com/) to view a live example of ## Requirements -- Node20 +- Node22 ## Setup @@ -217,7 +217,7 @@ git config core.hooksPath .githooks ### [Vue collapse transition](https://github.com/ivanvermeyen/vue-collapse-transition) -- It is used for collapses elements horizontally or vertically. +- It is used for collapsing elements horizontally or vertically. ### [FontAwesome](https://github.com/FortAwesome/Font-Awesome) @@ -235,4 +235,4 @@ This repository is owned and maintained by the [Canopas team](https://canopas.co ## LICENSE -Canopas website is released under the [GNU V3](https://github.com/canopas/canopas-website/blob/master/LICENSE.md). +The Canopas website has been released under the [GNU V3](https://github.com/canopas/canopas-website/blob/master/LICENSE.md).