|
1 | | -# Open Superintelligence Lab |
| 1 | +This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
2 | 2 |
|
3 | | -A modern, responsive website for the Open Superintelligence Lab, built with Next.js and deployed to GitHub Pages. |
| 3 | +## Getting Started |
4 | 4 |
|
5 | | -## 🚀 Quick Start |
| 5 | +First, run the development server: |
6 | 6 |
|
7 | | -### Prerequisites |
8 | | - |
9 | | -- Node.js 18+ |
10 | | -- npm or yarn |
11 | | - |
12 | | -### Installation |
13 | | - |
14 | | -1. Clone the repository: |
15 | | -```bash |
16 | | -git clone https://github.com/Open-Superintelligence-Lab/Open-Superintelligence-Lab.github.io.git |
17 | | -cd Open-Superintelligence-Lab.github.io |
18 | | -``` |
19 | | - |
20 | | -2. Install dependencies: |
21 | | -```bash |
22 | | -npm install |
23 | | -``` |
24 | | - |
25 | | -3. Run the development server: |
26 | 7 | ```bash |
27 | 8 | npm run dev |
| 9 | +# or |
| 10 | +yarn dev |
| 11 | +# or |
| 12 | +pnpm dev |
| 13 | +# or |
| 14 | +bun dev |
28 | 15 | ``` |
29 | 16 |
|
30 | | -4. Open [http://localhost:3000](http://localhost:3000) in your browser. |
31 | | - |
32 | | -## 📦 Available Scripts |
33 | | - |
34 | | -- `npm run dev` - Start development server |
35 | | -- `npm run build` - Build the application for production |
36 | | -- `npm run start` - Start production server |
37 | | -- `npm run export` - Build and export static files |
38 | | -- `npm run deploy` - Deploy to GitHub Pages |
39 | | - |
40 | | -## 🏗️ Project Structure |
41 | | - |
42 | | -``` |
43 | | -├── app/ # Next.js App Router |
44 | | -│ ├── globals.css # Global styles |
45 | | -│ ├── layout.tsx # Root layout |
46 | | -│ └── page.tsx # Home page |
47 | | -├── components/ # React components |
48 | | -│ ├── Hero.tsx # Hero section |
49 | | -│ ├── About.tsx # About section |
50 | | -│ ├── Research.tsx # Research areas |
51 | | -│ ├── Contact.tsx # Contact section |
52 | | -│ └── Footer.tsx # Footer |
53 | | -├── .github/workflows/ # GitHub Actions |
54 | | -└── public/ # Static assets |
55 | | -``` |
56 | | - |
57 | | -## 🎨 Features |
58 | | - |
59 | | -- **Modern Design**: Clean, professional layout with gradient backgrounds |
60 | | -- **Responsive**: Mobile-first design that works on all devices |
61 | | -- **Fast**: Optimized for performance with Next.js |
62 | | -- **SEO Ready**: Proper meta tags and semantic HTML |
63 | | -- **Accessible**: WCAG compliant components |
64 | | - |
65 | | -## 🚀 Deployment |
66 | | - |
67 | | -This site is automatically deployed to GitHub Pages using GitHub Actions. Every push to the `main` branch triggers a deployment. |
68 | | - |
69 | | -### Manual Deployment |
70 | | - |
71 | | -If you need to deploy manually: |
72 | | - |
73 | | -```bash |
74 | | -npm run export |
75 | | -``` |
76 | | - |
77 | | -This will create an `out` folder with static files that can be served by GitHub Pages. |
78 | | - |
79 | | -## 🔧 Configuration |
80 | | - |
81 | | -The site is configured for GitHub Pages deployment in `next.config.js`: |
82 | | - |
83 | | -- Static export enabled |
84 | | -- Asset prefix set for GitHub Pages |
85 | | -- Base path configured for repository name |
86 | | - |
87 | | -## 📝 Customization |
88 | | - |
89 | | -### Adding New Sections |
90 | | - |
91 | | -1. Create a new component in `components/` |
92 | | -2. Import and add it to `app/page.tsx` |
93 | | -3. Style with Tailwind CSS classes |
94 | | - |
95 | | -### Changing Colors |
96 | | - |
97 | | -The site uses a blue-purple gradient theme. To change colors, update the gradient classes in: |
98 | | -- `components/Hero.tsx` |
99 | | -- `components/Footer.tsx` |
100 | | - |
101 | | -### Updating Content |
| 17 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
102 | 18 |
|
103 | | -Edit the component files in `components/` to update text, links, and other content. |
| 19 | +You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
104 | 20 |
|
105 | | -## 🤝 Contributing |
| 21 | +This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
106 | 22 |
|
107 | | -1. Fork the repository |
108 | | -2. Create a feature branch: `git checkout -b feature-name` |
109 | | -3. Make your changes |
110 | | -4. Commit: `git commit -m 'Add feature'` |
111 | | -5. Push: `git push origin feature-name` |
112 | | -6. Open a Pull Request |
| 23 | +## Learn More |
113 | 24 |
|
114 | | -## 📄 License |
| 25 | +To learn more about Next.js, take a look at the following resources: |
115 | 26 |
|
116 | | -This project is open source and available under the [MIT License](LICENSE). |
| 27 | +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
| 28 | +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
117 | 29 |
|
118 | | -## 🔗 Links |
| 30 | +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
119 | 31 |
|
120 | | -- **Live Site**: [https://open-superintelligence-lab.github.io/Open-Superintelligence-Lab.github.io](https://open-superintelligence-lab.github.io/Open-Superintelligence-Lab.github.io) |
121 | | -- **GitHub**: [https://github.com/Open-Superintelligence-Lab/Open-Superintelligence-Lab.github.io](https://github.com/Open-Superintelligence-Lab/Open-Superintelligence-Lab.github.io) |
| 32 | +## Deploy on Vercel |
122 | 33 |
|
123 | | ---- |
| 34 | +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
124 | 35 |
|
125 | | -Built with ❤️ by the Open Superintelligence Lab team. |
| 36 | +Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
0 commit comments