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

feat: added agency starter to next #2

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions next/agency/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/bcms.config.js
/bcms.routes.js
/next.config.js
27 changes: 27 additions & 0 deletions next/agency/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended"
],
// "extends": "next/core-web-vitals",
"rules": {
"no-debugger": "warn",
"no-shadow": "error",
"no-console": "warn",
"semi": "error",
"quotes": ["error", "single"],
"indent": ["error", 2],
"@typescript-eslint/no-unused-vars": [
2,
{ "args": "all", "argsIgnorePattern": "^_" }
],
"no-unused-labels": "error",
"no-unused-expressions": "error",
"no-duplicate-imports": "error"
}
}
46 changes: 46 additions & 0 deletions next/agency/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local
.env

# vercel
.vercel

# typescript
*.tsbuildinfo

# BCMS
/bcms
/logs
/public/bcms-media
/public/api/bcms-images
/bcms-components
/public/api/bcms-media
8 changes: 8 additions & 0 deletions next/agency/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"bracketSpacing": true,
"tabWidth": 2,
"printWidth": 80
}
118 changes: 118 additions & 0 deletions next/agency/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
https://github.com/bcms/starters/assets/15079459/84dcf8dd-4cf9-48b8-919f-07f359ea9541

<h1 align="center">Agency website with Next.js and BCMS</h1>
<p align="center"><a href="https://agency-starter.thebcms.com/">See this website in action ⤴</a></p>
<p align="center">Spin up a fully functional agency website with Next.js, Tailwind, and <a href="https://github.com/bcms/cms">BCMS</a> - in a few minutes.<br/>
Everything from managing services page, portfolio posts, team page, to contact us page. All within the same codebase.</p>

---

<p align="center">
<span>If you like the project, hit that ⭐ button</span>
</p>

---

<p align="center">Whether you are looking to build an agency website for your company or for a client - this starter will save you weeks. You can clone this folder, connect it with your own BCMS instance, and give it a go!</p>
<br/>

<h2 align="center">How it works</h2>
<br/>

<h3 align="center">Step 1: Clone the repo</h3>
<p align="center">This repository contains a lot of starters. Enter <code>agency</code>, but make sure to check other starters too, later.</p>

```bash
git clone https://github.com/bcms/starters.git
```

<br/>
<h3 align="center">Step 2: Start BCMS (Backend)</h3>
<p align="center">This step will make sure that you are running BCMS locally and in the background, which is required before starting the Next.js development server.</p>

```bash
cd starters/cms/agency
```

<p>Run <code>docker-compose build</code> command, followed with <code>docker-compose up</code>.</p>
<p>Your BCMS instance is now up and running, and can be inspected by visiting <code>http://localhost:8080</code>.</p>

<br/>
<h3 align="center">Step 3: Start Next.js (Frontend)</h3>
<p align="center">After this step you will be able to edit the Frontend side of your starter, everything from styles, content, pages structure and much more.</p>

```bash
cd starters/next/agency
```

<p>Before anything, make sure to install node packages ( <code>npm install</code> ).</p>
<p>Run <code>npm run dev</code> command to start the local frontend development server. This will pull the data from the BCMS which is running in the background.</p>
<p>Your Next app is now up and running and can be inspected by visiting <code>http://localhost:3000</code>.</p>

---

<br>
<br>

<h2>FAQs</h2>
<h3>
Is this Next.js starter template compatible with the latest version of
Next.js?
</h3>
<p>
Yes, the template is designed to be compatible with the latest version of
Next.js. Make sure to regularly check for updates to ensure compatibility.
</p>

<h3>
Can I integrate other headless CMS platforms besides BCMS with this starter?
</h3>
<p>
Absolutely! While it's optimized for BCMS, the structure allows for
integration with other headless CMS platforms. You might need to make some
adjustments based on your chosen CMS.
</p>

<h3>How customizable is the design? Can I change the theme or colors?</h3>
<p>
The design is highly customizable. We used Tailwind for that very reason Just
go to [tailwind.config.js](/tailwind.config.js). There, you can easily change
the theme, colors, fonts, and other design elements to match your brand.
</p>

<h3>Is there any built-in SEO optimization with this starter?</h3>
<p>Yes, the starter follows the SEO best practices.</p>
<img width="631" alt="image" src="https://github.com/bcms/starters/assets/15079459/1011ce99-10a7-465f-9671-cdd2792d4a34">

<h3>
How is the performance of the website? Does it support lazy loading for
images?
</h3>
<p>
The website is optimized for performance. It supports lazy loading for images
to ensure faster page loads, especially with a large number of recipes.
</p>
<img width="743" alt="image" src="https://github.com/bcms/starters/assets/15079459/3d2a47a6-d47d-41e9-86f5-ec038c1bc1a6">

<h3>Are there any pre-configured analytics or tracking tools integrated?</h3>
<p>
The starter doesn't come with pre-configured analytics tools, but it's
straightforward to integrate tools like Google Analytics or other tracking
solutions.
</p>

<h3>
I'm new to Next.js. Do you provide documentation or support for setting up the
starter?
</h3>

Yes, the starter comes with detailed documentation to help you get started. A few useful resources:

- [BCMS documentation](https://docs.thebcms.com/integrations/next-js)
- [Official Next.js documentation](https://nextjs.org/docs)
- [Sign up to BCMS](https://cloud.thebcms.com/)

<h2>Support ❤️</h2>
<p>
If you like the project, hit that ⭐ button!
</p>
Loading